JRLY Configuration File

The format of the configuration file is a TAG=VALUE format. Blank lines or lines starting with a “#” are ignored. The following listing contains an example of the formal specifications of the configuration file.

Listing Specification of Configuration File

LOGDIR=<LOG_DIRECTORY_PATH>
ACCESS_LOG=<ACCESS_FILE_NAME in LOGDIR>
ERROR_LOG=<ERROR_FILE_NAME in LOGDIR>
LISTEN=<IP:Port combination where JRLY will accept connections>
CONNECT=<IP:Port combination associated with JRAD>
SOCKETTIMEOUT=<Seconds for socket accept()function>

Note:

SOCKETTIMEOUT is the duration (in seconds) of which the relay Windows service blocks the establishment of new socket connections to allow network activity (new connections, data to be read, closed connections). It is valid only on Windows machines. SOCKETTIMEOUT also affects the SCM. When the SCM requests that the service stop, the SCM needs to wait at least SOCKETTIMEOUT seconds before doing so.

The following listing shows an example of the JRLY configuration file. The CONNECT line specifies the IP address and port number of JRAD machine.

Listing Example of JRLY Configuration File

LOGDIR=/usr/log/relay
ACCESS_LOG=access_log
ERROR_LOG=errorlog
# jrly will listen on port 4444
LISTEN=200.100.10.100:4444
CONNECT=machine1:port1
CONNECT=machine2:port2
SOCKETTIMEOUT=30                 //See text under listing

The format for directory and filenames is determined by the operating system. UNIX systems use the forward slash (/). Windows systems use the backslash (\). If any file specified in LOGDIR, ACCESS_LOG or ERROR_LOG cannot be opened for writing, the JRLY prints an error message on stderr and exits.

The formats for host names and port numbers are shown in the following table.

Note:

JRLY supports IPv6.

Table 3-4 Host Name and Port Number Formats

IPv4	IPv6
`//IP:port` IP is a dotted notation IP address, `port` is a decimal number	`//[IPv6 address]:port`
`//hostname:port_number` IP is a dotted notation IP address, `port` is a decimal number	`//hostname:port_number`
`//#.#.#.#:port_number`	`Hex format is not supported`

Parent topic: Jolt Relay