Revision | Comments |
---|---|
1.1 | Author(s): Francis L'Écuyer (francisl@zks.net);
Initial draft. |
1.2 | Updated to reflect the design change that now makes the Command Server a pre-forking server. |
Option name | Option Parameter | Description |
Help | NA | Show a list of command line options. |
Config | Configuration file | Specify the configuration file. |
ListenQueueLength | Queue length | Maximum number of incoming pending connections. |
MaxIdleTime | Time (seconds) | This is the maximum number of seconds that a server will wait for sending or receiving a command. Note that special value 0 will disable the idle timer. |
MaxConnections | Number of maximum simultaneous connections | This specifies the number of simultaneous connections that the Command Server can handle. Note that the Command Server is a pre-forking server so an child process is forked for each possible connections. Be carefull with the number provided when running multiple Command Server on the same machine. |
ProcessLife | Number of connections | The process life is the number of connections that each pre-forked child process handles before terminating. Note that when a process terminates another one is forked to replace it. A process life of 0 indicates an immortal process. |
MaxPacketSize | Size (kBytes) | This is the maximum size of packets tha can be transmitted. |
TcpDelay | NA | Indicate to use delay when sending data over TCP link. This prevents the server from using the TCP_NODELAY socket option. |
AuthKey | string | Specifies the key to use for packet authentication (in MAC) |
AddressPath | string | Server listening path (e.g. "host:port" or only ":port") |
AccessFile | Path and file | File name and path for the access file containing the IP addresses that are allowed to connect. |
LogFile | Path and file | Path and file name of the log file. |
PidFile | PID file | The PID file contains the process identifier of the running Command Server |
Verbose | 0 to 4 | Specifies the logging verbose level. This is an integer value between 0 to 4, where 0 provides almost no logging (error only) and 4 logs all input. |
Debug | NA | This turns on debugging mode. |
DontFork | NA | Prevents the server from running in background when launched. |
NoChildren | NA | When specified, the server process will not fork processes to handle new connections but will handle them itself. |
Example:
It is also possible to specify sub-networks using an IP address
and a mask. Two formats are available for sub-net addresses:
As seen in the above examples, comments can be inserted by preceding
byt the ';' character.
Note that because the Command Server is a pre-forking server special
care must be taken to be sure that all processes are signaled. For that,
when the server starts it creates a process group to which all processes
belong. The syntax to signal a group is to use the parent process ID and
prefix it with a dash. For example, the following would be used to
rotate the log file: