This class contains the details about an individual connection. More...

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

Public Member Functions
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 the details about an individual connection.

It extends the Observable class to allow a user program to be informed about changes to the statistics of the connection.

Member Function Documentation

virtual System.Collections.IEnumerator com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getBoundNodes ( )

virtual

Returns an collection of nNodes that this connection is bound to.

Returns: An IEnumerator of nNode objects that this connection is bound to.

virtual long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getEventsReceived ( )

virtual

Returns the number of events that this connection has received from the remote client

Returns: a long representing the number of events received by this connection

virtual long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getEventsTransmitted ( )

virtual

Returns the number of events sent to the remote client

Returns: a long representing the number of events transmitted by this connection

virtual string com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getId ( )

virtual

Returns the unique connection ID used to identify this connection

Returns: The connection ID as a String

virtual string com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getLastReceivedEvent ( )

virtual

Returns a protocol description of the last event received from the connection

Returns: a String containing the protocol description of the last event received

virtual string com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getLastTransmittedEvent ( )

virtual

Returns a protocol description of the last event transmitted from the connection

Returns: a String containing the protocol description of the last event transmitted

virtual int com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getLatency ( )

virtual

This field is updated by the client heartbeat and as such only changes when the server receives a heart beat from the client

Returns: a int in milliseconds of the last request/response

virtual string com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getProtocol ( )

virtual

This method returns the protocol string, currently one of NSP, NHP, NSPS or NHPS.

Returns: A String indicating the protocol used by this connection

virtual int com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getQueueSize ( )

virtual

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.

Returns: a long representing the queue size

virtual string com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getRealmName ( )

virtual

Returns the name of the realm

Returns: the name of the realm

virtual long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getReceivedByteCount ( )

virtual

Returns the number of bytes that this connection has received from the remote client

Returns: Long count

virtual string com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getSelector ( nLeafNode leafNode )

virtual

Returns the Selector that the connection used to bind to a channel/queue

Parameters

leafNode The node being queried

Returns: the selector used for event filtering as a String

Exceptions

nAdminIllegalArgumentException is thrown if leafNode is null

virtual string [] com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getSubject ( )

virtual

Returns an array of strings that the connection used to authenticate with the server.

The first entry is the primary principal and is the only one used in the ACL validation. The array will only contain more than one entry in a Client certificate validated SSL session which will use CN as the primary principal followed by the user supplied principal.

Returns: A list of subjects as a String[]

virtual long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getTimeOfLastReceive ( )

virtual

Returns the timestamp since the last received event

Returns: a long representing the timestamp since the last received event

virtual long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getTimeOfLastTransmitt ( )

virtual

Returns the number of milliseconds since the last event was sent

Returns: a long representing the timestamp since the last transmitted event

virtual long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getTransimittedByteCount ( )

virtual

Returns the number of bytes that this connection has transmitted to the remote client

Returns: the number of bytes transmitted by this connection as a long

virtual long com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.getUpTime ( )

virtual

Returns the number of milliseconds that the connection has been active for

Returns: a long representing the number of ms the server has been up

virtual bool com.pcbsys.nirvana.nAdminAPI.nConnectionDetails.wasClosedByClient ( )

virtual

This method will show that after this connection has received a delete callback, whether the close was initiated by the client.

The client close is generated from the nSessionFactory.close(nSession) method. Other closes or disconnections will return false, since the client did not send a session close event.

Returns: true if the client initiated the session close

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation