Connexis uses command-line options for specifying the configuration of the distributed application and for various settings used by the library. If you need to implement additional preferences for your application you can introduce additional custom command-line options at the end of the command-line, or use some other mechanism for information passing such as environment variables or a configuration file.
Each command-line option has a name and an alias (i.e., short name). Below the most commonly-used command-line options are described. For a full list of all available command-line options, refer to the Connexis library class DCS::Logical View::DCSComponents::DCSSysConfig::RTDConfigDefaultData.
General command-line options.
| Command-Line Option | Description |
|---|---|
CNXunique_id (CNXui) |
An identifier for the executable which should be unique within the distributed application. Choose a name that describes the role played by the executable in the application. Argument Type: string Default Value: a randomly generated id |
CNXnobanner (CNXnb) |
Suppresses the printing of a banner at start-up. This banner may contain diagnostic messages or initialization errors. |
CNXdump (CNXd) |
Prints the actual values of all command-line options that will be used. This includes what has been specified on the command-line as well as default values. |
CNXhelp (CNXh) |
Prints information about all available command-line options. |
Command-line options related to transports.
| Command-Line Option | Description |
|---|---|
CNXendpoint (CNXep) |
Sets the endpoint for a transport. The endpoint is a string in the format: <transport>://<address>If the transport is omitted, it defaults to CDM. If the address just specifies a port and no hostname, the hostname defaults to localhost. Argument Type: string Default Value: none |
CNXcdm_max_rx_size (CNXcmrs) |
Configures the maximum CDM receive message size. Argument Type: int Default Value: Derived from the size of the biggest buffer in the buffer pool (see CNXtran_buffer_pool). |
CNXcdm_udp_rx_size (CNXcurs) |
Configures the maximum UDP receive message size. Argument Type: int Default Value: Depends on the operating system used. |
CNXcdm_udp_tx_size (CNXcuts) |
Configures the maximum UDP transmit size. Argument Type: int Default Value: Depends on the operating system used. |
CNXtran_buffer_pool (CNXtbp) |
Configures the buffer pool. For each buffer in the pool this option specifies the buffer size followed by the number of buffers. Argument Type: string Default Value: 64:1,600:10,4200:10,17000:2,32860:2,33000:2 |
CNXtran_first_msg_size (CNXtms) |
Configures the first message (i.e. initial buffer) size when encoding. Argument Type: int Default Value: 600 |
CNXtran_max_tx_size (CNXtmts) |
Configures the maximum transmit message size for a transport. Argument Type: int Default Value: none |
| Command-Line Option | Description |
|---|---|
CNXlocator_primary (CNXlp) |
Specifies that this process should be the primary locator. Argument Type: none Default Value: none |
CNXlocator_backup (CNXlb) |
Specifies that this process should be the backup locator. Argument Type: none Default Value: none |
CNXlocator_primary_endpoint (CNXlpep) |
Specifies the endpoint of the primary locator. This option must be specified for all executables in the distributed application, except the one that hosts the primary locator. Argument Type: string Default Value: none |
CNXlocator_backup_endpoint (CNXlbep) |
Specifies the endpoint of the backup locator. This option must be specified for all executables in the distributed application, except the one that hosts the backup locator. Argument Type: string Default Value: none |
CNXlocator_retry_delay (CNXlrd) |
Specifies the amount of time, in milliseconds, to wait before retries. The value must be > 50. Argument Type: integer Default Value: 10000 |
CNXlocator_audit_delay (CNXlad) |
Specifies the amount of time, in milliseconds, to wait between audits of the primary and backup locators. The value must be > 500. See CNXlocator_audits— this option controls how long the backup locator will wait before declaring the primary locator unavailable and starts the fail-over procedure.Argument Type: integer Default Value: 20000 |
CNXlocator_audits_oos(CNXlao) |
Specifies the number of failed audits required to take the primary locator out of service. If this number is exceeded, the backup locator will be taken out of service after the third consecutive audit has failed. Argument Type: integer Default Value: 3 |
CNXlocator_preferred_transport (CNXlpt) |
Specifies the preferred transport protocol to be used in case there are multiple transports with the same rank. This option can only be set for the primary or backup locators. Argument Type: string Default Value: none |
Command-line options for configuring the Metrics Service.
| Command-Line Options | Descriptions |
|---|---|
CNXmetrics (CNXm) |
Specifies whether metrics should be collected at application start-up, before the Metrics Service SPP port has become bound. Set it to 1 to collect metrics at start-up.Argument Type: boolean int Default Value: 0 (false) |