gemfire_statistics::StatisticsFactory Class Reference

Inherits gemfire_statistics::StatisticsTypeFactory.


Detailed Description

Instances of this interface provide methods that create instances of Statistics.

It can also be used to create instances of StatisticDescriptor and StatisticsType because it implements StatisticsTypeFactory *

A StatisticsFactory can create a statistic of three numeric types: int, long, and double. A statistic (StatisticDescriptor) can either be a gauge meaning that its value can increase and decrease or a counter meaning that its value is strictly increasing. Marking a statistic as a counter allows the GemFire Manager Console to properly display a statistics whose value "wraps around" (that is, exceeds its maximum value).

Public Member Functions

virtual Statistics * createAtomicStatistics (StatisticsType *type, const char *textId, int64 numericId)=0
 Creates and returns a Statistics instance of the given type, textId, and numericId.
virtual Statistics * createAtomicStatistics (StatisticsType *type, const char *textId)=0
 Creates and returns a Statistics instance of the given type, textId, and with a default numeric id.
virtual Statistics * createAtomicStatistics (StatisticsType *type)=0
 Creates and returns a Statistics instance of the given type with default ids.
virtual
StatisticDescriptor
createDoubleCounter (const char *name, const char *description, const char *units, int8 largerBetter=true)=0
 Creates and returns an int gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.
virtual
StatisticDescriptor
createDoubleGauge (const char *name, const char *description, const char *units, int8 largerBetter=false)=0
 Creates and returns an double gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.
virtual
StatisticDescriptor
createIntCounter (const char *name, const char *description, const char *units, int8 largerBetter=true)=0
 Creates and returns a long counter StatisticDescriptor with the given name, description, units,and with larger values indicating better performance.
virtual
StatisticDescriptor
createIntGauge (const char *name, const char *description, const char *units, int8 largerBetter=false)=0
 Creates and returns an int gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.
virtual
StatisticDescriptor
createLongCounter (const char *name, const char *description, const char *units, int8 largerBetter=true)=0
 Creates and returns a double counter StatisticDescriptor with the given name, description, units, and with larger values indicating better performance.
virtual
StatisticDescriptor
createLongGauge (const char *name, const char *description, const char *units, int8 largerBetter=false)=0
 Creates and returns an long gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.
virtual Statistics * createOsStatistics (StatisticsType *type, const char *textId, int64 numericId, int32 osStatFlags)=0
 Creates and returns a Statistics instance of the given type, textId, and numericId, osStatFlags Only those Stat objects which collect operating system values like ProcessStats, SystemStats should set this flag to true.
virtual Statistics * createStatistics (StatisticsType *type, const char *textId, int64 numericId)=0
 Creates and returns a Statistics instance of the given type, textId, and numericId.
virtual Statistics * createStatistics (StatisticsType *type, const char *textId)=0
 Creates and returns a Statistics instance of the given type, textId, and with a default numeric id.
virtual Statistics * createStatistics (StatisticsType *type)=0
 Creates and returns a Statistics instance of the given type with default ids.
virtual StatisticsTypecreateType (const char *name, const char *description, StatisticDescriptor **stats, int32 statsLength)=0
 Creates and returns a StatisticsType with the given name, description, and StatisticDescriptor.
virtual Statistics * findFirstStatisticsByType (StatisticsType *type)=0
 Return the first instance that matches the type, or NULL.
virtual StatisticsTypefindType (const char *name)=0
 Finds and returns an already created StatisticsType with the given name.

Static Public Member Functions

static
StatisticsFactory
getExistingInstance ()
 Return a pre-existing statistics factory.


Member Function Documentation

virtual Statistics* gemfire_statistics::StatisticsFactory::createAtomicStatistics ( StatisticsType type,
const char *  textId,
int64  numericId 
) [pure virtual]

Creates and returns a Statistics instance of the given type, textId, and numericId.

The created instance will be atomic.

virtual Statistics* gemfire_statistics::StatisticsFactory::createAtomicStatistics ( StatisticsType type,
const char *  textId 
) [pure virtual]

Creates and returns a Statistics instance of the given type, textId, and with a default numeric id.

The created instance will be atomic.

virtual Statistics* gemfire_statistics::StatisticsFactory::createAtomicStatistics ( StatisticsType type  )  [pure virtual]

Creates and returns a Statistics instance of the given type with default ids.

The created instance will be atomic.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createDoubleCounter ( const char *  name,
const char *  description,
const char *  units,
int8  largerBetter = true 
) [pure virtual, inherited]

Creates and returns an int gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createDoubleGauge ( const char *  name,
const char *  description,
const char *  units,
int8  largerBetter = false 
) [pure virtual, inherited]

Creates and returns an double gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createIntCounter ( const char *  name,
const char *  description,
const char *  units,
int8  largerBetter = true 
) [pure virtual, inherited]

Creates and returns a long counter StatisticDescriptor with the given name, description, units,and with larger values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createIntGauge ( const char *  name,
const char *  description,
const char *  units,
int8  largerBetter = false 
) [pure virtual, inherited]

Creates and returns an int gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createLongCounter ( const char *  name,
const char *  description,
const char *  units,
int8  largerBetter = true 
) [pure virtual, inherited]

Creates and returns a double counter StatisticDescriptor with the given name, description, units, and with larger values indicating better performance.

virtual StatisticDescriptor* gemfire_statistics::StatisticsTypeFactory::createLongGauge ( const char *  name,
const char *  description,
const char *  units,
int8  largerBetter = false 
) [pure virtual, inherited]

Creates and returns an long gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance.

virtual Statistics* gemfire_statistics::StatisticsFactory::createOsStatistics ( StatisticsType type,
const char *  textId,
int64  numericId,
int32  osStatFlags 
) [pure virtual]

Creates and returns a Statistics instance of the given type, textId, and numericId, osStatFlags Only those Stat objects which collect operating system values like ProcessStats, SystemStats should set this flag to true.

The created instance may not be atomic.

virtual Statistics* gemfire_statistics::StatisticsFactory::createStatistics ( StatisticsType type,
const char *  textId,
int64  numericId 
) [pure virtual]

Creates and returns a Statistics instance of the given type, textId, and numericId.

The created instance may not be atomic.

virtual Statistics* gemfire_statistics::StatisticsFactory::createStatistics ( StatisticsType type,
const char *  textId 
) [pure virtual]

Creates and returns a Statistics instance of the given type, textId, and with a default numeric id.

The created instance may not be atomic.

virtual Statistics* gemfire_statistics::StatisticsFactory::createStatistics ( StatisticsType type  )  [pure virtual]

Creates and returns a Statistics instance of the given type with default ids.

The created instance may not be atomic.

virtual StatisticsType* gemfire_statistics::StatisticsTypeFactory::createType ( const char *  name,
const char *  description,
StatisticDescriptor **  stats,
int32  statsLength 
) [pure virtual, inherited]

Creates and returns a StatisticsType with the given name, description, and StatisticDescriptor.

Exceptions:
IllegalArgumentException if a type with the given name already exists.

virtual Statistics* gemfire_statistics::StatisticsFactory::findFirstStatisticsByType ( StatisticsType type  )  [pure virtual]

Return the first instance that matches the type, or NULL.

virtual StatisticsType* gemfire_statistics::StatisticsTypeFactory::findType ( const char *  name  )  [pure virtual, inherited]

Finds and returns an already created StatisticsType with the given name.

Returns null if the type does not exist.

static StatisticsFactory* gemfire_statistics::StatisticsFactory::getExistingInstance (  )  [static]

Return a pre-existing statistics factory.

Typically configured through creation of a distributed system.


GemFire C++ Cache API Documentation