EMA C++ Edition
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
List of all members
thomsonreuters::ema::access::ChannelStatistics Class Reference

ChannelStats provides statistical information on application channel(s). More...

Public Member Functions

Constructor
 ChannelStatistics ()
 
 ChannelStatistics (const UInt64 tcpRetransmitCount)
 
Destructor
virtual ~ChannelStatistics ()
 
Accessors
void clear ()
 
bool hasTcpRetransmitCount () const
 
UInt64 getTcpRetransmitCount () const
 
Operations
ChannelStatisticstcpRetransmitCount (const UInt64 tcpRetransmitCount)
 

Detailed Description

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 ChannelStatistics usage are found in the example: (IProvider) IProvider/400_Series/460__MarketPrice__RTT

Definition at line 37 of file ChannelStatistics.h.

Constructor & Destructor Documentation

thomsonreuters::ema::access::ChannelStatistics::ChannelStatistics ( )

Constructs ChannelStatistics.

thomsonreuters::ema::access::ChannelStatistics::ChannelStatistics ( const UInt64  tcpRetransmitCount)

Constructs ChannelStatistics.

Parameters
[in]tcpRetransmitCount
virtual thomsonreuters::ema::access::ChannelStatistics::~ChannelStatistics ( )
virtual

Destructor.

Member Function Documentation

void thomsonreuters::ema::access::ChannelStatistics::clear ( )

Clears the ChannelStatistics

Remarks
invoking clear() resets all member variables to their default values
UInt64 thomsonreuters::ema::access::ChannelStatistics::getTcpRetransmitCount ( ) const

Gets the TCP Retransmition Count.

Exceptions
OmmInvalidUsageExceptionif hasTcpRetransmitCount() returns false
Returns
the TCP Retransmition Count
bool thomsonreuters::ema::access::ChannelStatistics::hasTcpRetransmitCount ( ) const
inline

Indicates presence of TCP Retransmition Count.

Returns
true if TCP Retransmition Count is set; false otherwise

Definition at line 74 of file ChannelStatistics.h.

ChannelStatistics& thomsonreuters::ema::access::ChannelStatistics::tcpRetransmitCount ( const UInt64  tcpRetransmitCount)

Specifies port number that was used to connect to the server (Consumer, NiProvider)

Parameters
[in]portspecifies port number
Returns
reference to this object