Configuration
SapiConfig¶
| Field | Type | Description |
|---|---|---|
| DiscoveryHosts | string[] | Network interface addresses and ports |
| Username | string | Username |
| Password | string | Password |
| ListenHosts | string[] | Hosts for the listening process |
| ListenPorts | string | Port range for the listening process |
| AdvertiseHosts | string[] | Advertised hosts |
| AdvertisePorts | string | Advertised ports |
| ConnTimeout | int | Connection timeout |
| GatewayStrategy | short | Gateway strategy used for determining destination Gateway. |
| GatewayHosts | string[] | Network interface addresses and ports for the Gateway (disables Discovery) |
| InstanceName | string | Process Name |
| Version | int | Code version |
| Build | string | Build information |
| ServiceClasses | string[] | Service classes of interest to client |
| RetryPolicy | RetryPolicy | Retry Policy |
| RtConfig | SapiRtConfig | RT configuration |
| SocketConfig | SapiSocketConfig | Socket configuration |
| Callbacks | SapiCallbacks | Callback configuration |
| Domain | string | Domain class |
| ServiceClass | string | Service class |
| Family | string | Data family |
| Addresses | string[] | Network interface addresses and ports |
| UdpPort | int | UDP port if used |
| GWWorkerThreadCount | short | Number of GW worker threads |
| RPWorkerThreadCount | short | Number of RP worker threads |
| MQWorkerThreadCount | short | Number of MQ worker threads |
| PublishWorkerThreadCount | short | Number of Publish worker threads |
| DSWorkerThreadCount | short | Number of DS worker threads |
| ReqMaxPending | int | Maximum number of in flight API requests |
| ReqMaxPendingBlock | bool | Whether to block requests after pending threshold is reached, otherwise reject request |
| UseTLS | bool | Whether to use TLS for remote process communication |
| Tls | SapiTls | TLS settings used for SAPI connections |
RetryPolicy¶
| Field | Type | Description |
|---|---|---|
| MaxAttempts | uint | Max number of attempts before timeout |
| Timeout | uint | Exit if timeout reached |
| RetryInterval | uint | Interval between attempts, in ms |
| RetryScaling | float | Retry interval backoff multiplier (must be ≥ 1) |
SapiSocketConfig¶
| Field | Type | Description |
|---|---|---|
| SocketRoundTripTime | int | Socket round trip time |
| SocketSendRate | int | Socket send rate |
| SocketReceiveRate | int | Socket receive rate |
SapiTls¶
| Field | Type | Description |
|---|---|---|
| CA | string | TLS CA certificate |
| CAFile | string | File location of TLS CA certificate. If provided, overrides the value for tlsCA |
| Cert | string | TLS certificate |
| CertFile | string | File location of TLS certificate. If provided, overrides the value for tlsCert |
| Key | string | Certificate key |
| KeyFile | string | File location of Certificate key. If provided, overrides the value for tlsKey |
| VerifyClient | bool | Verify that the certificate provided to incoming connections is valid |
| VerifyServer | bool | Verify that the certificate provided to outgoing connections is valid |
SapiRtConfig¶
| Field | Type | Description |
|---|---|---|
| UseBridge | bool | Whether to use a bridge connection |
| ConfigUrl | string | URL or file used to discover endpoint(s). Default: none |
| ConfigPath | string | Path for creating local configuration (used if ConfigUrl is null) |
| ClientName | string | Client name |
| Prefix | string | Prefix |
| Stream | string | Stream |
| ClientType | string | Client type |
| EndPoints | string | Endpoints |
| RtPort | string | Real-time port |
| Dir | string | RT logs directory. Default: /tmp/rt (Linux), c:/Temp/rt (Windows) |
| CaInfoFile | string | CA cert bundle file path. Default: empty string |
| ConfigMaxAge | uint | Max age of config details (ms). Default: 300000 |
| FetchConfigSleep | uint | Delay between config reads (ms). Default: 5000 |
| LocalPersistencePeriod | uint | Local persistence period (ms). Default: 600000 |
| ConnTimeout | uint | Connection timeout (ms). Default: 2000 |
| ConsoleLogLevel | string | Console log level (info/warn/err/off). Default: err |
| ReplFileLogLevel | string | Replicator file log level (trace/debug/info/warn/error/fatal/off). Default: off |
| ReplConsoleLogLevel | string | Replicator console log level (trace/debug/info/warn/error/fatal/off). Default: err |
| LogLevel | string | General log level (info/warn/err/off). Default: info |
| DedupId | string | ID used to deduplicate multiple publishers. Default: none |
| LogPosition | string | Subscriber start position. Default: 0 |
| RestPortStart | int | Port to start REST server. Default: 0 |
| PauseThreshold | int | Disk usage threshold (GB) for pausing replication. Default: 0 |
| ExchangeArchived | int | Whether archived events should be sent to server. Default: 0 |
| TruncateArchived | int | Whether archived files should be auto-truncated. Default: 1 |
| FlushTimeoutSecs | int | Timeout for flushing local logs to server on close. Default: no timeout |
| RtLogSizeSoftCap | nuint | Soft cap for RT log file size. Default: 0 |
| RtLogSizeHardCap | nuint | Hard cap for RT log file size. Default: 0 |
| DeleteFiles | int | Whether to delete log files. Default: 0 |
KxsResponse¶
| Field | Type | Description |
|---|---|---|
| ReqCorr | long | Request correlator |
| QueueTm | int | Queue time (in milliseconds) |
| SvcTm | int | Service time (in milliseconds) |
| RC | short | Return code |
| AC | short | Application code |
| AI | string | Application information |
| Header | object | Header of response |
| Payload | object | Payload of response |
SapiCallbacks¶
| Field | Type | Description |
|---|---|---|
| GwConnected | IntPtr | Callback triggered by any gateway connection being established |
| GwsConnected | IntPtr | Callback triggered when all gateways have at least a single connection established |
| RpConnected | IntPtr | Callback triggered when a remote process (RP) connection was established |