gemfire_statistics::StatisticDescriptor Class Reference


Detailed Description

Describes an individual statistic whose value is updated by an application and may be archived by GemFire.

These descriptions are gathered together in a StatisticsType.

To get an instance of this interface use an instance of StatisticsFactory.

StatisticDescriptors are naturally ordered by their name.

Public Member Functions

virtual const char * getDescription ()=0
 Returns a description of this statistic.
virtual int32 getId ()=0
 Returns the id of this statistic in a StatisticsType.
virtual const char * getName ()=0
 Returns the name of this statistic.
virtual const char * getUnit ()=0
 Returns the unit in which this statistic is measured.
virtual int8 isCounter ()=0
 Returns true if this statistic is a counter; false if its a gauge.
virtual int8 isLargerBetter ()=0
 Returns true if a larger statistic value indicates better performance.


Member Function Documentation

virtual const char* gemfire_statistics::StatisticDescriptor::getDescription (  )  [pure virtual]

Returns a description of this statistic.

virtual int32 gemfire_statistics::StatisticDescriptor::getId (  )  [pure virtual]

Returns the id of this statistic in a StatisticsType.

The id is initialized when its statistics type is created.

virtual const char* gemfire_statistics::StatisticDescriptor::getName (  )  [pure virtual]

Returns the name of this statistic.

virtual const char* gemfire_statistics::StatisticDescriptor::getUnit (  )  [pure virtual]

Returns the unit in which this statistic is measured.

virtual int8 gemfire_statistics::StatisticDescriptor::isCounter (  )  [pure virtual]

Returns true if this statistic is a counter; false if its a gauge.

Counter statistics have values that always increase. Gauge statistics have unconstrained values.

virtual int8 gemfire_statistics::StatisticDescriptor::isLargerBetter (  )  [pure virtual]

Returns true if a larger statistic value indicates better performance.


GemFire C++ Cache API Documentation