ChannelInfo provides information on application channel(s). More...
Public Types | |
enum | ChannelState { ClosedEnum = -1 , InactiveEnum = 0 , InitializingEnum = 1 , ActiveEnum = 2 } |
enum | CompressionType { NoneEnum = 0x00 , ZLIBEnum = 0x01 , LZ4Enum = 0x02 } |
enum | ConnectionType { Unidentified = -1 , SocketEnum = 0 , EncryptedEnum = 1 , HttpEnum = 2 , Unidir_ShmemEnum = 3 , Reliable_McastEnum = 4 , Ext_Line_SocketEnum = 5 , Seq_McastEnum = 6 , WebSocketEnum = 7 } |
enum | ProtocolType { UnknownEnum = -1 , RwfEnum = 0 , RsslJsonEnum = 2 } |
For IProvider applications, this channel information is about channels used by clients to connect to the IProvider application.
For Consumer and NiProvider applications, this channel information is about the outbound channel (e.g., the channel used by a Consumer application to connect to an ADS) used to connect for receiving data (Consumer) or sending data (NiProvider).
Examples of ChannelInformation usage are found in the examples: (Consumer) Consumer/100_Series/170__MarketPrice__ChannelInfo (IProvider) IProvider/100_Series/170__MarketPrice__ConnectedClientInfo (NiProvider) NiProvider/100_Series/170__MarketPrice__ChannelInfo
Definition at line 39 of file ChannelInformation.h.
An enumeration representing channel states.
Definition at line 46 of file ChannelInformation.h.
An enumeration representing compression types.
Enumerator | |
---|---|
NoneEnum | (0) No compression will be negotiated. |
ZLIBEnum | (1) Will attempt to use Zlib compression. |
LZ4Enum | (2) Will attempt to use LZ4 compression |
Definition at line 89 of file ChannelInformation.h.
An enumeration representing connection types.
Definition at line 57 of file ChannelInformation.h.
An enumeration representing protocol types.
Enumerator | |
---|---|
UnknownEnum | (-1) Unknown wireformat protocol |
RwfEnum | (0) LSEG wireformat protocol |
RsslJsonEnum | (2) Rssl JSON protocol |
Definition at line 79 of file ChannelInformation.h.
refinitiv::ema::access::ChannelInformation::ChannelInformation | ( | ) |
Constructs ChannelInformation.
refinitiv::ema::access::ChannelInformation::ChannelInformation | ( | const EmaString & | connectedComponentInfo, |
const EmaString & | hostname, | ||
const EmaString & | ipAddress, | ||
const ChannelState | channelState, | ||
const ConnectionType | connectionType, | ||
const ProtocolType | protocolType, | ||
const UInt32 | majorVersion, | ||
const UInt32 | minorVersion, | ||
const UInt32 | pingTimeout | ||
) |
Constructs ChannelInformation.
[in] | connectedComponentInfo | |
[in] | hostname | |
[in] | ipAddress | |
[in] | channelState | |
[in] | connectionType | |
[in] | protocolType | |
[in] | majorVersion | |
[in] | minorVersion | |
[in] | pingTimeout |
|
virtual |
Destructor.
ChannelInformation& refinitiv::ema::access::ChannelInformation::channelState | ( | ChannelState | channelState | ) |
Specifies channel state
[in] | channelState | specifies channel state as a ChannelState enum |
void refinitiv::ema::access::ChannelInformation::clear | ( | ) |
Clears the ChannelInformation
ChannelInformation& refinitiv::ema::access::ChannelInformation::compressionThreshold | ( | UInt32 | compressionThreshold | ) |
Specifies the compression threshold
[in] | compressionThreshold | specifies compression threshold |
ChannelInformation& refinitiv::ema::access::ChannelInformation::compressionType | ( | UInt32 | compressionType | ) |
Specifies the compression type
[in] | compressionType | specifies compression type |
ChannelInformation& refinitiv::ema::access::ChannelInformation::connectedComponentInfo | ( | const EmaString & | connectedComponentInfo | ) |
Specifies connected component info
[in] | connectedComponentInfo | specifies connected component info as a string |
ChannelInformation& refinitiv::ema::access::ChannelInformation::connectionType | ( | ConnectionType | connectionType | ) |
Specifies connection type
[in] | connectionType | specifies connection type as a ConnectionType enum |
ChannelInformation& refinitiv::ema::access::ChannelInformation::encryptionProtocol | ( | UInt64 | encryptionProtocol | ) |
Specifies the encryption protocol
[in] | encryptionProtocol | specifies the encryption protocol |
|
inline |
Gets the channel state as a ChannelState enum
Definition at line 165 of file ChannelInformation.h.
|
inline |
Gets the compression threshold
Definition at line 230 of file ChannelInformation.h.
|
inline |
Gets the compression type
Definition at line 225 of file ChannelInformation.h.
|
inline |
Gets the connected component info as a string
Definition at line 141 of file ChannelInformation.h.
|
inline |
Gets the connection type as a ConnectionType enum
Definition at line 170 of file ChannelInformation.h.
|
inline |
Gets the encryption protocol
Definition at line 235 of file ChannelInformation.h.
|
inline |
Gets the guaranteed number of output buffers
Definition at line 205 of file ChannelInformation.h.
|
inline |
Gets the hostname as a string
Definition at line 147 of file ChannelInformation.h.
|
inline |
Gets the IP address of the connected client
Definition at line 160 of file ChannelInformation.h.
|
inline |
Gets the major version
Definition at line 180 of file ChannelInformation.h.
|
inline |
Gets the max fragment size
Definition at line 195 of file ChannelInformation.h.
|
inline |
Gets the maximum number of output buffers
Definition at line 200 of file ChannelInformation.h.
|
inline |
Gets the minor version
Definition at line 185 of file ChannelInformation.h.
|
inline |
Gets the number of input buffers
Definition at line 210 of file ChannelInformation.h.
|
inline |
Gets the ping timeout
Definition at line 190 of file ChannelInformation.h.
|
inline |
Gets the protocol type as a ProtocolType enum
Definition at line 175 of file ChannelInformation.h.
|
inline |
Gets the systems receive Buffer size
Definition at line 220 of file ChannelInformation.h.
|
inline |
Gets the systems send Buffer size
Definition at line 215 of file ChannelInformation.h.
ChannelInformation& refinitiv::ema::access::ChannelInformation::guaranteedOutputBuffers | ( | UInt32 | guaranteedOutputBuffers | ) |
Specifies the guaranteed number of output buffers
[in] | guaranteedOutputBuffers | specifies guaranteed number of output buffers |
ChannelInformation& refinitiv::ema::access::ChannelInformation::hostname | ( | const EmaString & | hostname | ) |
Specifies hostname
[in] | hostname | specifies hostname as a string |
ChannelInformation& refinitiv::ema::access::ChannelInformation::ipAddress | ( | const EmaString & | ipAddress | ) |
Specifies the IP address of the connected client
[in] | ipAddress | specifies IP address as a string |
ChannelInformation& refinitiv::ema::access::ChannelInformation::majorVersion | ( | UInt32 | majorVersion | ) |
Specifies major version
[in] | majorVersion | specifies majorVersion |
ChannelInformation& refinitiv::ema::access::ChannelInformation::maxFragmentSize | ( | UInt32 | maxFragmentSize | ) |
Specifies the max fragment size
[in] | maxFragmentSize | specifies max fragment size |
ChannelInformation& refinitiv::ema::access::ChannelInformation::maxOutputBuffers | ( | UInt32 | maxOutputBuffers | ) |
Specifies the maximum number of output buffers
[in] | maxOutputBuffers | specifies maximum number of output buffers |
ChannelInformation& refinitiv::ema::access::ChannelInformation::minorVersion | ( | UInt32 | minorVersion | ) |
Specifies minor version
[in] | minorVersion | specifies minorVersion |
ChannelInformation& refinitiv::ema::access::ChannelInformation::numInputBuffers | ( | UInt32 | numInputBuffers | ) |
Specifies the number of input buffers
[in] | guaranteedOutputBuffers | specifies number of input buffers |
refinitiv::ema::access::ChannelInformation::operator const char * | ( | ) | const |
Operator const char* overload
ChannelInformation& refinitiv::ema::access::ChannelInformation::pingTimeout | ( | UInt32 | pingTimeout | ) |
Specifies ping timeout
[in] | pingTimeout | specifies ping timeout |
|
inline |
Gets the port number that was used to connect to the server ADS/ADH (Consumer, NiProvider). Valid for SOCKET connection type
Definition at line 153 of file ChannelInformation.h.
ChannelInformation& refinitiv::ema::access::ChannelInformation::port | ( | const UInt16 | port | ) |
Specifies port number that was used to connect to the server (Consumer, NiProvider)
[in] | port | specifies port number |
ChannelInformation& refinitiv::ema::access::ChannelInformation::protocolType | ( | ProtocolType | protocolType | ) |
Specifies protocol type
[in] | protocolType | specifies protocol type as a ProtocolType enum |
ChannelInformation& refinitiv::ema::access::ChannelInformation::sysRecvBufSize | ( | UInt32 | sysRecvBufSize | ) |
Specifies the systems Receive Buffer size
[in] | sysRecvBufSize | specifies systems receive Buffer size |
ChannelInformation& refinitiv::ema::access::ChannelInformation::sysSendBufSize | ( | UInt32 | sysSendBufSize | ) |
Specifies the systems Send Buffer size
[in] | sysSendBufSize | specifies systems send Buffer size |
const EmaString& refinitiv::ema::access::ChannelInformation::toString | ( | ) | const |
Gets a string representation of the class instance.
![]() |
![]() |
|