com.pcbsys.nirvana.nAdminAPI.nChannelConnectionDetails Class Reference

This class contains additional information about a channel connection. More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nChannelConnectionDetails:
com.pcbsys.nirvana.nAdminAPI.nConnectionDetails

Public Member Functions

String getChannel ()
 Get the name of the channel. More...
 
String getNamedSubscriber ()
 If the connection used a nNamedObject then this method would return the name of the nNamedObject. More...
 
String getSelector ()
 Returns the message selector used for the connection if asynchronous. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nConnectionDetails
Enumeration getBoundNodes ()
 Returns an collection of nNodes that this connection is bound to. More...
 
String getBuildDate ()
 Returns the date that the client version was built. More...
 
String getBuildNumber ()
 The Nirvana build number that the client is using to connect. More...
 
long getEventsReceived ()
 Returns the number of events that this connection has received from the remote client. More...
 
long getEventsTransmitted ()
 Returns the number of events sent to the remote client. More...
 
String getId ()
 Returns the unique connection ID used to identify this connection. More...
 
String getLanguageVersion ()
 Returns the language that the client application is using e.g. More...
 
String getLastReceivedEvent ()
 Returns a protocol description of the last event received from the connection. More...
 
String getLastTransmittedEvent ()
 Returns a protocol description of the last event transmitted from the connection. More...
 
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...
 
String getOSName ()
 Returns the name of the operating system that the client application is running on. More...
 
String getOSVersion ()
 Returns the version of the operating system the client application is running on. More...
 
String getProtocol ()
 This method returns the protocol string, currently one of NSP, NHP, NSPS or NHPS. More...
 
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...
 
String getRealmName ()
 Returns the name of the realm. More...
 
long getReceivedByteCount ()
 Returns the number of bytes that this connection has received from the remote client. More...
 
String getSelector (nLeafNode leafNode) throws nAdminIllegalArgumentException
 Returns the Selector that the connection used to bind to a channel/queue. More...
 
String getSessionName ()
 Returns the name of this session as set by the client API. More...
 
String[] getSubject ()
 Returns an array of strings that the connection used to authenticate with the server. More...
 
long getTimeOfLastReceive ()
 Returns the timestamp since the last received event. More...
 
long getTimeOfLastTransmitt ()
 Returns the number of milliseconds since the last event was sent. More...
 
long getTransmittedByteCount ()
 Returns the number of bytes that this connection has transmitted to the remote client. More...
 
long getUpTime ()
 Returns the number of milliseconds that the connection has been active for. More...
 
boolean isMulticastEnabled ()
 Returns if multicast is enabled. More...
 
boolean requirePriorityConnection ()
 Queries if this connection requires a priority connection. More...
 
boolean wasClosedByClient ()
 This method will show that after this connection has received a delete callback, whether the close was initiated by the client. More...
 

Detailed Description

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.

Member Function Documentation

String com.pcbsys.nirvana.nAdminAPI.nChannelConnectionDetails.getChannel ( )

Get the name of the channel.

Returns
String name of the channel
String com.pcbsys.nirvana.nAdminAPI.nChannelConnectionDetails.getNamedSubscriber ( )

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 assiociated with this connection.

Returns
String name of the nNamedObject
String com.pcbsys.nirvana.nAdminAPI.nChannelConnectionDetails.getSelector ( )

Returns the message selector used for the connection if asynchronous.

If no selector was used then this method returns null. Returns null for synchronous connections.

Returns
Message selector used.