Transformer SDK For C
6.2.11.309924
|
datasrc-batch-time
Type: Floating Point Value
Default: 0.010000
Minimum: 0.000000
Maximum: 10.000000
Time period in seconds to batch together messages sent to another peer.
This can improve performance when sending high update rates. Note that messages will only be batched together if the rate is faster than the batch time.
datasrc-name
Type: String
Default: %a-%h
The name of this DataSource, and how DataSource peers will identify it.
This name can be overridden by putting a value in the local-name
option of the add-peer add-peer entry.
%a is replaced by application_name and %h is replaced by the host name of the machine.
Example:
datasrc-interface
Type: String
Default: None
Network interface to listen for connections from DataSource peers.
The default is to listen on all available interfaces.
datasrc-port
Type: Integer
Default: 0
Network port to listen for connections from DataSource peers. The default of 0 means that no connections can be made to this DataSource.
datasrc-id
Type: Integer
Default: 0
ID number of this DataSource. This ID can be overridden by putting a value in the local-id
option of the add-peer entry, in which case it must match the remote-id given
in the add-peer entry in the remote DataSource's configuration.
datasrc-local-label
Type: String
Default: None
Local label of this DataSource. This label can be overridden by putting a value in the local-label
option of the add-peer entry, in which case it must match the remote-label given
in the add-peer entry in the remote DataSource's configuration.
datasrc-pkt-log
Type: String
Default: packet-%a.log
Name of this DataSource's packet log file. The location of the file must either be relative to log-dir or absolute.
%a is replaced by application_name.
peer-thread-pool-size
Type: Integer
Default: -1
Number of threads for peers.
If this option is configured then a pool of threads is created which is used to handle the non-named ( see below ) configured peers. The option configures the maximum number of threads in the pool.
If the option is configured then all add-peer configurations that do not have the thread-name
option configured i.e. ( non-named ) will be handled on one of the pool threads.
If this option is not configured then a thread is created per configured peer.
If more than 30 peers are being configured then it is recommended that this option is configured.
add-peer
Adds a DataSource peer. You can have a maximum of 1023 add-peer entries in your configuration.
Format:
add-peer remote-id [value] remote-name [value] remote-flags [value] remote-type [value] local-id [value] local-name [value] local-flags [value] local-type [value] addr [value] port [value] queue-size [value] obj-hash-size [value] ssl heartbeat-time [value] heartbeat-slack-time [value] connect-timeout [value] label [value] remote-label [value] local-label [value] end-peer
ssl-accept-certificate
Type: String Array
Default: None
list of certificates we expect the client to send
port
Type: Integer Array
Default: None
addr
Type: String Array
Default: None
local-handshake-data
Type: String Array
Default: None
label
Type: String
Default: None
Label used for advanced source mapping. Deprecated, please use remote-label.
remote-label
Type: String
Default: None
Label used for advanced source mapping.
local-label
Type: String
Default: None
remote-id
Type: Integer
Default: -1
remote-name
Type: String
Default: None
remote-flags
Type: Integer
Default: 0
Acceptable Values:
Name | Value | Desc |
---|---|---|
none | 0 | No special restart or reconnection |
recvautoreplay | 4 | When restarting, this peer should accept replay updates. |
noconnect | 8 | Prevents the automatic connection to peers on startup. |
remote-type
Type: Integer
Default: 0
Acceptable Values:
Name | Value | Desc |
---|---|---|
none | 0 | This source is broadcast and can't accept contributions |
broadcast | 0 | This source is broadcast and can't accept contributions |
active | 1 | This source is active |
contrib | 2 | This source can accept contributions |
local-id
Type: Integer
Default: -1
local-name
Type: String
Default: None
local-flags
Type: Integer
Default: 0
Acceptable Values:
Name | Value | Desc |
---|---|---|
none | 0 | No special restart or reconnection |
recvautoreplay | 4 | When restarting, this peer should accept replay updates. |
noconnect | 8 | Prevents the automatic connection to peers on startup. |
local-type
Type: Integer
Default: 0
Acceptable Values:
Name | Value | Desc |
---|---|---|
none | 0 | This source is broadcast and can't accept contributions |
broadcast | 0 | This source is broadcast and can't accept contributions |
active | 1 | This source is active |
contrib | 2 | This source can accept contributions |
queue-size
Type: Integer
Default: 50
active-request-timeout
Type: Floating Point Value
Deprecated: Yes
Default: -1.000000
Use add-peer/request-timeout instead
request-timeout
Type: Floating Point Value
Default: -1.000000
heartbeat-time
Type: Integer
Default: -1
Minimum: 1
Time in seconds between heartbeats. The default of -1 indicates that heartbeats will be disabled unless enabled by the remote peer.
heartbeat-slack-time
Type: Floating Point Value
Default: 2.000000
Minimum: 0.100000
Time in seconds after a heartbeat should have been received that the connection to the remote peer is closed and reconnection attempts are made.
connect-timeout
Type: Integer
Default: 10
When a connection has been made to a host that either doesn't exist or is not currently routable the OS will attempt to connect for upto approximately 4 minutes (this time is dependent on various OS tunable parameters).
For the purposes of obtaining real-time data this period is too long. Setting the connect-timeout
option within an add-peer
section allows the timeout to be altered. If the timeout expires then any backup peers within the add-peer
section will be contacted and connections made.
monitor-interval
Type: Floating Point Value
Default: 0.000000
Interval between updating monitoring statistics
thread-name
Type: String
Default: None
Name of the thread for running this peer.
If this option is configured then a thread is guaranteed to be created for the configured peer even if the peer-thread-pool-size
option is configured.
If multiple peers have this option configured to the same name then those peers are handled by the same thread. In this way a number of peers with a low update rate can be grouped together.
If a peer is expected to have more than 10000 updates per second it is recommended that the peer is handled by its own thread. This can be achieved by setting the thread name to a unique name.
ssl
Type: Boolean
Default: FALSE
Incoming/Outgoing SSL connections only
ssl-verify-mode
Type: Integer
Default: -1
Acceptable Values:
Name | Value | Desc |
---|---|---|
SSL_VERIFY_NONE | 0 | |
SSL_VERIFY_PEER | 1 | |
SSL_VERIFY_FAIL_IF_NO_PEER_CERT | 2 | |
SSL_VERIFY_CLIENT_ONCE | 4 |
ssl-cipherlist
Type: String
Default: None
optional list of ciphers to use, overrides global settings
ssl-present-certificate
Type: String
Default: None
SSL certificate to be sent/presented to the server
ssl-privatekey
Type: String
Default: None
private key file for the certificate
ssl-passwordfile
Type: String
Default: None
file containing the password for the private key
datasrc-reject-new-peers
Type: Boolean
Default: FALSE
If your DataSource application tries to connect to a DataSource peer but there is already one connected with the same id, the current one will be disconnected and the new one allowed to connect.
datasrc-reject-new-peers
turns off this default behaviour so the new DataSource peer is not allowed to connect.
datasrc-tcp-nodelay-off
Type: Boolean
Default: FALSE
Turn off TCP_NODELAY. By default all DataSource peer connections have TCP_NODELAY enabled. This option allows the feature to be disabled.
peer-monitor-interval
Type: Floating Point Value
Default: 30.000000
Interval between collation of statistics
peer-accept-wait-time
Type: Floating Point Value
Default: 10.000000
Time to wait for an info packet when accepting a connection