Contains the status of a Nirvana Realm server interface
More...
Inherits com.pcbsys.nirvana.client.Observable.
|
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
|
|
Contains the status of a Nirvana Realm server interface
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