EpcTools
An event based multi-threaded C++ development framework.
Public Member Functions | List of all members
EStatistics::Peer Class Reference

Contains the peer information including the statistics for the individual messages. More...

#include <estats.h>

Public Member Functions

 Peer (cpStr name, const EStatistics::MessageStatsMap &tmplt)
 Class constructor. More...
 
 Peer (const EString &name, const EStatistics::MessageStatsMap &tmplt)
 Class constructor. More...
 
 Peer (const Peer &p)
 Class constructor. More...
 
EStatistics::MessageStatsgetMessageStats (UInt msgid)
 Retrieves the statistics for a specific message. More...
 
EStringgetName ()
 Retrieves the peer name. More...
 
ETimegetLastActivity ()
 Retrieves the time stamp of the last activity. More...
 
ETimesetLastActivity ()
 Assigns the time stamp of the last activity. More...
 
EStatistics::MessageStatsMapgetMessageStats ()
 Retrieves the message statistics collection for this peer. More...
 
Void reset ()
 Sets all message statistics counters to zero. More...
 
UInt incRequestSentErrors (UInt msgid)
 Increments the request send errors for the specified message. More...
 
UInt incRequestReceivedErrors (UInt msgid)
 Increments the request receive errors for the specified message. More...
 
UInt incRequestSentOk (UInt msgid)
 Increments the request send successes for the specified message. More...
 
UInt incRequestReceivedOk (UInt msgid)
 Increments the request receive successes for the specified message. More...
 
UInt incResponseSentErrors (UInt msgid)
 Increments the response send errors for the specified message. More...
 
UInt incResponseReceivedErrors (UInt msgid)
 Increments the response receive errors for the specified message. More...
 
UInt incResponseSentOkAccepted (UInt msgid)
 Increments the response send success aceepted for the specified message. More...
 
UInt incResponseSentOkRejected (UInt msgid)
 Increments the response send success rejected for the specified message. More...
 
UInt incResponseReceivedOkAccepted (UInt msgid)
 Increments the response received success aceepted for the specified message. More...
 
UInt incResponseReceivedOkRejected (UInt msgid)
 Increments the response received success rejected for the specified message. More...
 

Detailed Description

Contains the peer information including the statistics for the individual messages.

Constructor & Destructor Documentation

◆ Peer() [1/3]

EStatistics::Peer::Peer ( cpStr  name,
const EStatistics::MessageStatsMap tmplt 
)

Class constructor.

Parameters
namethe peer name.
tmpltthe list of messages to maintain statistics for.

◆ Peer() [2/3]

EStatistics::Peer::Peer ( const EString name,
const EStatistics::MessageStatsMap tmplt 
)

Class constructor.

Parameters
namethe peer name.
tmpltthe list of messages to maintain statistics for.

◆ Peer() [3/3]

EStatistics::Peer::Peer ( const Peer p)

Class constructor.

Parameters
pthe Peer object to copy.

Member Function Documentation

◆ getLastActivity()

ETime& EStatistics::Peer::getLastActivity ( )
inline

Retrieves the time stamp of the last activity.

Returns
the time stamp of the last activity.

◆ getMessageStats() [1/2]

EStatistics::MessageStatsMap& EStatistics::Peer::getMessageStats ( )
inline

Retrieves the message statistics collection for this peer.

Returns
the message statistics collection for this peer.

◆ getMessageStats() [2/2]

EStatistics::MessageStats & EStatistics::Peer::getMessageStats ( UInt  msgid)

Retrieves the statistics for a specific message.

Returns
the statistics for a specific message.

◆ getName()

EString& EStatistics::Peer::getName ( )
inline

Retrieves the peer name.

Returns
the peer name.

◆ incRequestReceivedErrors()

UInt EStatistics::Peer::incRequestReceivedErrors ( UInt  msgid)
inline

Increments the request receive errors for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated request receive errors.

◆ incRequestReceivedOk()

UInt EStatistics::Peer::incRequestReceivedOk ( UInt  msgid)
inline

Increments the request receive successes for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated request receive successes.

◆ incRequestSentErrors()

UInt EStatistics::Peer::incRequestSentErrors ( UInt  msgid)
inline

Increments the request send errors for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated request send errors.

◆ incRequestSentOk()

UInt EStatistics::Peer::incRequestSentOk ( UInt  msgid)
inline

Increments the request send successes for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated request send successes.

◆ incResponseReceivedErrors()

UInt EStatistics::Peer::incResponseReceivedErrors ( UInt  msgid)
inline

Increments the response receive errors for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated response receive errors.

◆ incResponseReceivedOkAccepted()

UInt EStatistics::Peer::incResponseReceivedOkAccepted ( UInt  msgid)
inline

Increments the response received success aceepted for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated response received success aceepted.

◆ incResponseReceivedOkRejected()

UInt EStatistics::Peer::incResponseReceivedOkRejected ( UInt  msgid)
inline

Increments the response received success rejected for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated response received success rejected.

◆ incResponseSentErrors()

UInt EStatistics::Peer::incResponseSentErrors ( UInt  msgid)
inline

Increments the response send errors for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated response send errors.

◆ incResponseSentOkAccepted()

UInt EStatistics::Peer::incResponseSentOkAccepted ( UInt  msgid)
inline

Increments the response send success aceepted for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated response send success aceepted.

◆ incResponseSentOkRejected()

UInt EStatistics::Peer::incResponseSentOkRejected ( UInt  msgid)
inline

Increments the response send success rejected for the specified message.

Parameters
msgidthe message identifier.
Returns
the updated response send success rejected.

◆ reset()

Void EStatistics::Peer::reset ( )

Sets all message statistics counters to zero.

◆ setLastActivity()

ETime& EStatistics::Peer::setLastActivity ( )
inline

Assigns the time stamp of the last activity.

Returns
the time stamp of the last activity.

The documentation for this class was generated from the following files: