EMA C++ Configuration Guide : 3 Configuration Groups : 3.4 Channel Group : 3.4.2 Universal Channel Entry Parameters
 
3.4.2 Universal Channel Entry Parameters
You can use the following parameters in any <Channel> entry, regardless of the ChannelType.
For additional information on how to set the Channel connection type using the ChannelType and EncryptedProtocolType parameters, refer to Section 3.4.3.
 
Table 7: Universal <Channel> Parameters  
Parameter Name
Type
Default
Notes
ChannelType
Enumeration
RSSL_SOCKET
Specifies the type of channel or connection used to connect to the server.
Calling the host function can change this field. For details on this event, refer to Section 4.4.2.
Use enumeration values with Enterprise Message API’s programmatic configuration (for further details, refer to Section 4.5). Available values include:
RSSL_SOCKET (0)
RSSL_ENCRYPTED (1): Supported on Windows OS and Linux.
RSSL_HTTP (2): Supported only on Windows OS
RSSL_RELIABLE_MCAST (4)
RSSL_WEBSOCKET (7)
ConnectionPingTimeout
UInt64
30000
Specifies the duration (in milliseconds) after which the Enterprise Message API terminates the connection if it does not receive communication or pings from the server.
DirectWrite
UInt64
0
Specifies whether to set the direct socket write flag when sending data on a channel.
When the flag is set, every package is sent on the wire immediately on the submit call. If direct write is not set, the package might be placed into an internal queue which is later flushed onto the wire.
Possible values are:
0: Send data without the direct socket write flag.
1: Send data with the direct socket write flag.
EnableSessionManagement
UInt64
0
Specifies whether the channel manages the authentication token on behalf of the user. If set to 1, the channel obtains the authentication token and refreshes it as needed on behalf of the user. The default setting is 0. You can use this parameter only in with Enterprise Message API consumers.
When EnableSessionManagement is set and used with implicit Service Discovery, the application must configure ChannelType to be RSSL_ENCRYPTED because endpoints obtained by querying RDP Service Discovery are encrypted endpoints.
GuaranteedOutputBuffers
UInt64
100
Specifies the number of guaranteed buffers (allocated at initialization time) available for use by each RsslChannel when writing data. Each buffer is created to contain maxFragmentSize bytes.
For details on RsslChannel and maxFragmentSize, refer to the Transport API C++ Edition Developers Guide.
HighWaterMark
UInt64
6000
Specifies the upper buffer-usage threshold for the channel.
InitializationTimeout
UInt64
5
(10 when used with RSSL_ENCRYPTED ChannelType)
Specifies the time (in seconds) to wait for the successful initialization of a channel.
InterfaceName
EmaString
“”
Specifies a character representation of the IP address or hostname of the local network interface over which the Enterprise Message API sends and receives content.
InterfaceName is for use in systems that have multiple network interface cards. If unspecified, the default network interface is used.
Location
EmaString
us-east-1
Used only when host and port are unspecified, Location specifies the cloud location of the service provider endpoint to which the RTSDK API establishes a connection. If Location is not specified, the default setting is us-east-1. In any particular cloud location, the Enterprise Message API connects to the endpoint that provides two available zones for the location (e.g., [us-east-1a, us-east-1b]).
You can use Location only on an RSSL_ENCRYPTED ChannelType.
Name
EmaString
 
Specifies the Channel’s name.
NumInputBuffers
UInt64
100
Specifies the number of buffers used to read data. Buffers are sized according to maxFragmentSize.
For details on RsslChannel and maxFragmentSize, refer to the Transport API C++ Edition Developers Guide.
ServiceDiscoveryRetryCount
UInt64
3
Specifies the number of times the RTSDK API attempts to reconnect a channel before forcing the API to retry service discovery.
Used only when:
Host and port are unspecified. Refer to Section 3.4.4.
EnableSessionManagement is set to 1.
For details on service discovery, refer to the Enterprise Message API C++ Edition Developers Guide.
NOTE: You can use this parameter only with Enterprise Message API consumers.
API will not retry to get an endpoint from the service discovery when the value is 0.
SysRecvBufSize
UInt64
On Windows:
65535
On Linux:
Specified by system
Specifies the size (in bytes) of the system's receive buffer for this channel. For exact, effective values, refer to your operating system documentation.
SysSendBufSize
UInt64
On Windows:
65535
On Linux:
Specified by system
Specifies the size (in bytes) of the system's send buffer for this channel. For exact, effective values, refer to your operating system documentation.