gemfire_admin::Statistic Class Reference

Inherits gemfire::SharedBase.

---

Detailed Description

class to represent a single Statistic of a StatisticResource

Author:

Jim Nist

Public Member Functions
void	addStatisticListener (const StatisticListener *listener)
	Registers a listener that receives callbacks when a sample for the Statistic is available.
const char *	getDescription ()
	Gets the full description of this Statistic.
double	getDouble ()
	Returns: the sample value for an Double Statistic
uint32_t	getInt ()
	Returns: the sample value for an Int Statistic
int64_t	getLong ()
	Returns: the sample value for an Long Statistic
const char *	getName ()
	Gets the identifying name of this Statistic.
bool	getType (StatisticsType *statisticsType)
	Gets the Statistics::StatisticsType of this instance.
const char *	getUnits ()
	Gets the unit of measurement this Statistic represents.
bool	isCounter ()
	Returns true if this Statistic represents a numeric value which always increases.
void	preserveSB () const
	Atomically increment reference count.
int32_t	refCount ()
	Returns: the reference count
void	releaseSB () const
	Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.
void	removeStatisticListener (const StatisticListener *listener)
	Unregisters a Statistic listener.
virtual	~Statistic ()

---

Constructor & Destructor Documentation

virtual gemfire_admin::Statistic::~Statistic

(

)

[virtual]

Methods

---

Member Function Documentation

void gemfire_admin::Statistic::addStatisticListener

(

const StatisticListener *

listener

)

Registers a listener that receives callbacks when a sample for the Statistic is available.

Parameters:

listener

pointer to an instance of the StatisticListener listner class

See also:

removeStatisticListener

const char* gemfire_admin::Statistic::getDescription

(

)

Gets the full description of this Statistic.

Returns:

the full description of this Statistic

double gemfire_admin::Statistic::getDouble

(

)

Returns:

the sample value for an Double Statistic

uint32_t gemfire_admin::Statistic::getInt

(

)

Returns:

the sample value for an Int Statistic

int64_t gemfire_admin::Statistic::getLong

(

)

Returns:

the sample value for an Long Statistic

const char* gemfire_admin::Statistic::getName

(

)

Gets the identifying name of this Statistic.

Returns:

the identifying name of this Statistic

bool gemfire_admin::Statistic::getType

(

StatisticsType *

statisticsType

)

Gets the Statistics::StatisticsType of this instance.

Parameters:

[out]

statisticsType

StatisticsType for this statistic

Returns:

true for successfully filling statisticsType, false for failure

const char* gemfire_admin::Statistic::getUnits

(

)

Gets the unit of measurement this Statistic represents.

Returns:

the unit of measurement this Statistic represents

bool gemfire_admin::Statistic::isCounter

(

)

Returns true if this Statistic represents a numeric value which always increases.

Returns:

true if this Statistic represents a value which always increases

void gemfire::SharedBase::preserveSB

(

)

const [inherited]

Atomically increment reference count.

int32_t gemfire::SharedBase::refCount

(

)

[inline, inherited]

Returns:

the reference count

void gemfire::SharedBase::releaseSB

(

)

const [inherited]

Atomically decrement reference count, the SharedBase object is automatically deleted when its reference count goes to zero.

void gemfire_admin::Statistic::removeStatisticListener

(

const StatisticListener *

listener

)

Unregisters a Statistic listener.

Parameters:

listener

pointer to an instance of the StatisticListener listner class

See also:

addStatisticListener

---