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 com.pcbsys.nirvana.client.Observable

Public Member Functions

virtual string getChannel ()
 Get the name of the channel More...
 
virtual string getNamedSubscriber ()
 If the connection used a nNamedObject then this method would return the name of the nNamedObject. More...
 
virtual string getSelector ()
 Returns the message selector used for the connection. More...
 
- Public Member Functions inherited from com.pcbsys.nirvana.nAdminAPI.nConnectionDetails
virtual
System.Collections.IEnumerator 
getBoundNodes ()
 Returns an collection of nNodes that this connection is bound to. More...
 
virtual long getEventsReceived ()
 Returns the number of events that this connection has received from the remote client More...
 
virtual long getEventsTransmitted ()
 Returns the number of events sent to the remote client More...
 
virtual string getId ()
 Returns the unique connection ID used to identify this connection More...
 
virtual string getLastReceivedEvent ()
 Returns a protocol description of the last event received from the connection More...
 
virtual 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 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 string getRealmName ()
 Returns the name of the realm More...
 
virtual long getReceivedByteCount ()
 Returns the number of bytes that this connection has received from the remote client More...
 
virtual string getSelector (nLeafNode leafNode)
 Returns the Selector that the connection used to bind to a channel/queue More...
 
virtual string[] getSubject ()
 Returns an array of strings that the connection used to authenticate with the server. More...
 
virtual long getTimeOfLastReceive ()
 Returns the timestamp since the last received event More...
 
virtual long getTimeOfLastTransmitt ()
 Returns the number of milliseconds since the last event was sent More...
 
virtual long getTransimittedByteCount ()
 Returns the number of bytes that this connection has transmitted to the remote client More...
 
virtual long 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...
 
- Public Member Functions inherited from com.pcbsys.nirvana.client.Observable
void addObserver (IObserver o)
 Adds an observer to the set of observers for this object, provided that it is not the same as some observer already in the set. More...
 
int countObservers ()
 Returns the number of observers of this Observable object. More...
 
void deleteObserver (IObserver o)
 Deletes an observer from the set of observers of this object. More...
 
void deleteObservers ()
 Clears the observer list so that this object no longer has any observers. More...
 
bool hasChanged ()
 Tests if this object has changed. More...
 
void notifyObservers ()
 If this object has changed, as indicated by the hasChanged method, then notify all of its observers and then call the clearChanged method to indicate that this object has no longer changed. More...
 
void notifyObservers (Object arg)
 If this object has changed, as indicated by the More...
 
 Observable ()
 Construct an Observable with zero Observers. More...
 

Additional Inherited Members

- Protected Member Functions inherited from com.pcbsys.nirvana.client.Observable
void clearChanged ()
 Indicates that this object has no longer changed, or that it has already notified all of its observers of its most recent change, so that the hasChanged method will now return false. More...
 
void setChanged ()
 Marks this Observable object as having been changed; the hasChanged method will now return true. 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

virtual string com.pcbsys.nirvana.nAdminAPI.nChannelConnectionDetails.getChannel ( )
virtual

Get the name of the channel

Returns
String name of the channel
virtual string com.pcbsys.nirvana.nAdminAPI.nChannelConnectionDetails.getNamedSubscriber ( )
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 assiociated with this connection.

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

Returns the message selector used for the connection.

If no selector was used then this method returns null.

Returns
Message selector used.