com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus Class Reference

Contains the status of a Nirvana Realm server interface More...

Inheritance diagram for com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus:
com.pcbsys.nirvana.client.Observable

Public Member Functions

virtual int getCurrentIdleCount ()
 Returns the number of idle threads waiting for connections More...
 
virtual string getErrorMessage ()
 Only valid if the state is s_error More...
 
virtual nInterface getInterface ()
 This method returns the interface configuration details More...
 
virtual long getPoolExhaused ()
 Returns the total number of times the thread pool reached 0 idle More...
 
int getReadBandWidth ()
 Return the amount of MBs read by this interface / second More...
 
virtual long getRxBytes ()
 Returns the number of bytes this interface has received More...
 
virtual int getStatus ()
 Returns the current status of this interface. More...
 
virtual long getTotalAuthenticationTime ()
 Return the total time spent authenticating connections More...
 
virtual long getTotalConnections ()
 Returns the total number of connections created by this interface More...
 
virtual long getTotalFailedConnections ()
 Returns the total number of connections which failed during the initial security handshake and validation More...
 
long getTotalReads ()
 Return the total amount of MBs read by this interface More...
 
long getTotalWrites ()
 Return the total amount of MBs written by this interface More...
 
virtual long getTxBytes ()
 Returns the number of bytes this interface has transmitted More...
 
virtual long getWaitTime ()
 Returns the total milliseconds that there was no accept thread processing new connections More...
 
int getWriteBandWidth ()
 Return the total amount of MBs written by this interface / second More...
 
override string ToString ()
 Return a string repsentation of the interface configuration 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...
 

Data Fields

const int s_error = 3
 Indicates an interface with an error during startup
 
const int s_started = 1
 Indicates a started state on an interface
 
const int s_stopped = 0
 Indicates a stopped state on an interface
 

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

Contains the status of a Nirvana Realm server interface

Member Function Documentation

virtual int com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getCurrentIdleCount ( )
virtual

Returns the number of idle threads waiting for connections

Returns
long count
virtual string com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getErrorMessage ( )
virtual

Only valid if the state is s_error

Returns
Exception message created during interface startup
virtual nInterface com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getInterface ( )
virtual

This method returns the interface configuration details

Returns
nInterface object containing the interface details
virtual long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getPoolExhaused ( )
virtual

Returns the total number of times the thread pool reached 0 idle

Returns
long count
int com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getReadBandWidth ( )

Return the amount of MBs read by this interface / second

Returns
Current rate of MBs read
virtual long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getRxBytes ( )
virtual

Returns the number of bytes this interface has received

Returns
long byte count
virtual int com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getStatus ( )
virtual

Returns the current status of this interface.

Can be one of stopped, started, paused or error

Returns
current status
virtual long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTotalAuthenticationTime ( )
virtual

Return the total time spent authenticating connections

Returns
long milliseconds
virtual long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTotalConnections ( )
virtual

Returns the total number of connections created by this interface

Returns
long count
virtual long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTotalFailedConnections ( )
virtual

Returns the total number of connections which failed during the initial security handshake and validation

Returns
long count
long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTotalReads ( )

Return the total amount of MBs read by this interface

Returns
Total MBs read
long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTotalWrites ( )

Return the total amount of MBs written by this interface

Returns
Total MBs written
virtual long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTxBytes ( )
virtual

Returns the number of bytes this interface has transmitted

Returns
long byte count
virtual long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getWaitTime ( )
virtual

Returns the total milliseconds that there was no accept thread processing new connections

Returns
long milliseconds
int com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getWriteBandWidth ( )

Return the total amount of MBs written by this interface / second

Returns
Total MBs written
override string com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.ToString ( )

Return a string repsentation of the interface configuration

Returns
the string that represents the interface configuration