OpenNet::StatisticsProvider Class Reference

The StatisticsProvider class. More...

#include <StatisticsProvider.h>

Inheritance diagram for OpenNet::StatisticsProvider:

Classes
struct	StatisticsDescription
	The StatisticsDescription structure. More...

Public Member Functions
virtual Status	GetStatistics (unsigned int *aOut, unsigned int aOutSize_byte, unsigned int *aInfo_byte=NULL, bool aReset=false)=0
	This methode return the statistics of the adapter. More...
OPEN_NET_PUBLIC unsigned int	GetStatisticsQty () const
	This methode returns the number of statistics counter. More...
const OPEN_NET_PUBLIC StatisticsDescription *	GetStatisticsDescriptions () const
	This methode returns the statistics counter descriptions. More...
virtual Status	ResetStatistics ()=0
	This methode resets the statistics of the adapter. More...
OPEN_NET_PUBLIC Status	DisplayStatistics (const unsigned int *aIn, unsigned int aInSize_byte, FILE *aOut, unsigned int aMinLevel=0)
	Display. More...

Detailed Description

The StatisticsProvider class.

Member Function Documentation

OPEN_NET_PUBLIC Status OpenNet::StatisticsProvider::DisplayStatistics	(	const unsigned int *	aIn,
		unsigned int	aInSize_byte,
		FILE *	aOut,
		unsigned int	aMinLevel = 0
	)

Display.

Parameters

aIn	The statistics to display
aInSize_byte	The statistics size
aOut	The output stream
aMinLevel	0 show all statistics

Return values

STATUS_OK

virtual Status OpenNet::StatisticsProvider::GetStatistics ( unsigned int *  aOut, unsigned int  aOutSize_byte, unsigned int *  aInfo_byte = NULL, bool  aReset = false  )

pure virtual

This methode return the statistics of the adapter.

Parameters

aOut	The methode return the statistics here.
aOutSize_byte	The output buffer size
aInfo_byte	The returned size
aReset	Reset statistics to 0

Return values

STATUS_OK
STATUS_IOCTL_ERROR
STATUS_NOT_ALLOWER_NULL_ARGUMENT

Implemented in OpenNet::Kernel.

const OPEN_NET_PUBLIC StatisticsDescription* OpenNet::StatisticsProvider::GetStatisticsDescriptions

(

)

const

This methode returns the statistics counter descriptions.

Returns

This method return the address of an insternal constant.

OPEN_NET_PUBLIC unsigned int OpenNet::StatisticsProvider::GetStatisticsQty

(

)

const

This methode returns the number of statistics counter.

Returns

The number of counters

virtual Status OpenNet::StatisticsProvider::ResetStatistics ( )

pure virtual

This methode resets the statistics of the adapter.

Return values

STATUS_OK
STATUS_IOCTL_ERROR

Implemented in OpenNet::Kernel.

---

The documentation for this class was generated from the following file:

• Includes/OpenNet/StatisticsProvider.h