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

#include <nInterfaceStatus.h>

Inherits Observable.

Public Member Functions
virtual int	getCurrentIdleCount ()
	Returns the number of idle threads waiting for connections. More...

virtual const std::string &	getErrorMessage ()
	Only valid if the state is s_error. More...

virtual nInterface *	getInterface ()
	This method returns the interface configuration details. More...

virtual longlong	getPoolExhausted ()
	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 longlong	getRxBytes ()
	Returns the number of bytes this interface has received. More...

virtual int	getStatus ()
	Returns the current status of this interface. More...

virtual longlong	getTotalAuthenticationTime ()
	Return the total time spent authenticating connections. More...

virtual longlong	getTotalConnections ()
	Returns the total number of connections created by this interface. More...

virtual longlong	getTotalFailedConnections ()
	Returns the total number of connections which failed during the initial security handshake and validation. More...

longlong	getTotalReads ()
	Return the total amount of MBs read by this interface. More...

longlong	getTotalWrites ()
	Return the total amount of MBs written by this interface. More...

virtual longlong	getTxBytes ()
	Returns the number of bytes this interface has transmitted. More...

virtual longlong	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...

	nInterfaceStatus (nDriverStatus pCfg, nInterfaceManager pIm)
	Constructs a new nInterfaceStatus. More...

virtual std::string	toString ()
	Return a string repsentation of the interface configuration. More...

Static Public Attributes
static const int	s_error = 3
	Indicates an interface with an error during startup.

static const int	s_started = 1
	Indicates a started state on an interface.

static const int	s_stopped = 0
	Indicates a stopped state on an interface.

Detailed Description

Contains the status of a Nirvana Realm server interface.

Constructor & Destructor Documentation

com::pcbsys::nirvana::nAdminAPI::nInterfaceStatus::nInterfaceStatus	(	nDriverStatus *	pCfg,
		nInterfaceManager *	pIm
	)

Constructs a new nInterfaceStatus.

Parameters

*pCfg	the nDriverStatus for this object
*pIm	the interface manager which this object is to use

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 const std::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 longlong com::pcbsys::nirvana::nAdminAPI::nInterfaceStatus::getPoolExhausted ( )

virtual

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

Returns: longlong 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 longlong 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 longlong com::pcbsys::nirvana::nAdminAPI::nInterfaceStatus::getTotalAuthenticationTime ( )

virtual

Return the total time spent authenticating connections.

Returns: longlong milliseconds

virtual longlong com::pcbsys::nirvana::nAdminAPI::nInterfaceStatus::getTotalConnections ( )

virtual

Returns the total number of connections created by this interface.

Returns: long count

virtual longlong 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

longlong com::pcbsys::nirvana::nAdminAPI::nInterfaceStatus::getTotalReads ( )

Return the total amount of MBs read by this interface.

Returns: Total MBs read

longlong com::pcbsys::nirvana::nAdminAPI::nInterfaceStatus::getTotalWrites ( )

Return the total amount of MBs written by this interface.

Returns: Total MBs written

virtual longlong com::pcbsys::nirvana::nAdminAPI::nInterfaceStatus::getTxBytes ( )

virtual

Returns the number of bytes this interface has transmitted.

Returns: long byte count

virtual longlong 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

virtual std::string com::pcbsys::nirvana::nAdminAPI::nInterfaceStatus::toString ( )

virtual

Return a string repsentation of the interface configuration.

Returns: the string that represents the interface configuration

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation