- com
- pcbsys
- nirvana
- nAdminAPI
- nChannelConnectionDetails
This class contains additional information about a channel connection. More...
#include <nChannelConnectionDetails.h>
Public Member Functions | |
| virtual const std::string & | getChannel () |
| Get the name of the channel. More... | |
| virtual const std::string & | getNamedSubscriber () |
| If the connection used a nNamedObject then this method would return the name of the nNamedObject. More... | |
| virtual const std::string & | getSelector () |
| Returns the message selector used for the connection. More... | |
| virtual int | getType () |
| Returns the type of the connection details this object represents. More... | |
| nChannelConnectionDetails (nConnectionDataContainer *pData, const std::string &selector, const std::string &name, const std::string &channel) | |
| Constructs a new nChannelConnectionDetails. More... | |
 Public Member Functions inherited from com::pcbsys::nirvana::nAdminAPI::nConnectionDetails | |
| virtual std::map< std::string, nNode * > & | getBoundNodes () |
| Returns an collection of nNodes that this connection is bound to. More... | |
| virtual longlong | getEventsReceived () |
| Returns the number of events that this connection has received from the remote client. More... | |
| virtual longlong | getEventsTransmitted () |
| Returns the number of events sent to the remote client. More... | |
| virtual const std::string & | getId () |
| Returns the unique connection ID used to identify this connection. More... | |
| virtual const std::string & | getLastReceivedEvent () |
| Returns a protocol description of the last event received from the connection. More... | |
| virtual const std::string & | getLastTransmittedEvent () |
| Returns a protocol description of the last event transmitted from the connection. More... | |
| virtual int | getLatency () |
| This field is updated by the client heartbeat and as such only changes when the server receives a heart beat from the client. More... | |
| virtual std::string | getProtocol () |
| This method returns the protocol string, currently one of NSP, NHP, NSPS or NHPS. More... | |
| virtual int | getQueueSize () |
| This queue size is the internal server buffer where all events are pushed awaiting delivery A large number here or a number that is not moving maybe indicative of a slow or problematic connection. More... | |
| virtual const std::string & | getRealmName () |
| Returns the name of the realm. More... | |
| virtual longlong | getReceivedByteCount () |
| Returns the number of bytes that this connection has received from the remote client. More... | |
| virtual const std::string & | getSelector (nLeafNode *pLeafNode) |
| Returns the Selector that the connection used to bind to a channel/queue. More... | |
| virtual std::string * | getSubject (int &numSubject) |
| Returns a string that the connection used to authenticate with the server. More... | |
| virtual longlong | getTimeOfLastReceive () |
| Returns the timestamp since the last received event. More... | |
| virtual longlong | getTimeOfLastTransmit () |
| Returns the number of milliseconds since the last event was sent. More... | |
| virtual longlong | getTransmittedByteCount () |
| Returns the number of bytes that this connection has transmitted to the remote client. More... | |
| virtual longlong | getUpTime () |
| Returns the number of milliseconds that the connection has been active for. More... | |
| virtual bool | wasClosedByClient () |
| This method will show that after this connection has received a delete callback, whether the close was initiated by the client. More... | |
This class contains additional information about a channel connection.
Typically a channel connection is a subscription from a client to a channel on a realm server.
| com::pcbsys::nirvana::nAdminAPI::nChannelConnectionDetails::nChannelConnectionDetails | ( | nConnectionDataContainer * | pData, |
| const std::string & | selector, | ||
| const std::string & | name, | ||
| const std::string & | channel | ||
| ) |
Constructs a new nChannelConnectionDetails.
| *pData | the nConnectionDataContainer for the connection |
| selector | the selector used in the subscription |
| name | the name of the subscriber |
| channel | the name of the channel the connection is made to |
|
virtual |
Get the name of the channel.
|
virtual |
If the connection used a nNamedObject then this method would return the name of the nNamedObject.
This method can return null if there is no nNamedObject associated with this connection.
|
virtual |
Returns the message selector used for the connection.
If no selector was used then this method returns null.
|
virtual |
Returns the type of the connection details this object represents.
In this case the object represents channel connection details.