Glossary:
com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus Class Reference
Contains the status of a Nirvana Realm server interface. More...Inherits java::util::Observable.
Public Member Functions | |
| int | getCurrentIdleCount () |
| Returns the number of idle threads waiting for connections. | |
| String | getErrorMessage () |
| Only valid if the state is s_error. | |
| nInterface | getInterface () |
| This method returns the interface configuration details. | |
| long | getPoolExhaused () |
| Returns the total number of times the thread pool reached 0 idle. | |
| int | getReadBandWidth () |
| Returns the read bandwidth. | |
| long | getRxBytes () |
| Returns the number of bytes this interface has received. | |
| int | getStatus () |
| Returns the current status of this interface. | |
| long | getTotalAuthenticationTime () |
| Return the total time spent authenticating connections. | |
| long | getTotalConnections () |
| Returns the total number of connections created by this interface. | |
| long | getTotalFailedConnections () |
| Returns the total number of connections which failed during the initial security handshake and validation. | |
| long | getTotalReads () |
| Returns the total number of reads. | |
| long | getTotalWrites () |
| Returns the total number of writes. | |
| long | getTxBytes () |
| Returns the number of bytes this interface has transmitted. | |
| long | getWaitTime () |
| Returns the total milliseconds that there was no accept thread processing new connections. | |
| int | getWriteBandWidth () |
| Returns the write bandwidth. | |
| String | toString () |
| Return a string repsentation of the interface configuration. | |
Static Public Attributes | |
| static final int | s_error = 3 |
| Indicates an interface with an error during startup. | |
| static final int | s_started = 1 |
| Indicates a started state on an interface. | |
| static final int | s_stopped = 0 |
| Indicates a stopped state on an interface. | |
Detailed Description
Contains the status of a Nirvana Realm server interface.Member Function Documentation
| int com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getCurrentIdleCount | ( | ) |
Returns the number of idle threads waiting for connections.
- Returns:
- long count
| String com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getErrorMessage | ( | ) |
Only valid if the state is s_error.
- Returns:
- Exception message created during interface startup
| nInterface com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getInterface | ( | ) |
This method returns the interface configuration details.
- Returns:
- nInterface object containing the interface details
| long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getPoolExhaused | ( | ) |
Returns the total number of times the thread pool reached 0 idle.
- Returns:
- long count
| int com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getReadBandWidth | ( | ) |
Returns the read bandwidth.
- Returns:
- the read bandwidth in bytes
- Since:
- 5.5
| long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getRxBytes | ( | ) |
Returns the number of bytes this interface has received.
- Returns:
- long byte count
| int com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getStatus | ( | ) |
Returns the current status of this interface.
Can be one of stopped, started, paused or error
- Returns:
- current status
| long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTotalAuthenticationTime | ( | ) |
Return the total time spent authenticating connections.
- Returns:
- long milliseconds
| long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTotalConnections | ( | ) |
Returns the total number of connections created by this interface.
- Returns:
- long count
| long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTotalFailedConnections | ( | ) |
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 | ( | ) |
Returns the total number of reads.
- Returns:
- the number of reads on the interface
- Since:
- 5.5
| long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTotalWrites | ( | ) |
Returns the total number of writes.
- Returns:
- the number of writes on the interface
- Since:
- 5.5
| long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getTxBytes | ( | ) |
Returns the number of bytes this interface has transmitted.
- Returns:
- long byte count
| long com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getWaitTime | ( | ) |
Returns the total milliseconds that there was no accept thread processing new connections.
- Returns:
- long milliseconds
| int com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.getWriteBandWidth | ( | ) |
Returns the write bandwidth.
- Returns:
- the write bandwidth in bytes
- Since:
- 5.5
| String com.pcbsys.nirvana.nAdminAPI.nInterfaceStatus.toString | ( | ) |
Return a string repsentation of the interface configuration.
- Returns:
- the string that represents the interface configuration
