GemStone::GemFire::Cache::StatisticsFactory Class Reference

---

Detailed Description

Instances of this interface provide methods that create instances of StatisticDescriptor and StatisticsType. Every StatisticsFactory is also a type factory.

A StatisticsFactory can create a StatisticDescriptor 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, String^ textId, int64 numericId)
virtual Statistics^	CreateAtomicStatistics (StatisticsType^ type, String^ textId)
virtual Statistics^	CreateAtomicStatistics (StatisticsType^ type)
virtual StatisticDescriptor^	CreateDoubleCounter (String^ name, String^ description, String^ units)
virtual StatisticDescriptor^	CreateDoubleCounter (String^ name, String^ description, String^ units, int8_t largerBetter)
virtual StatisticDescriptor^	CreateDoubleGauge (String^ name, String^ description, String^ units)
virtual StatisticDescriptor^	CreateDoubleGauge (String^ name, String^ description, String^ units, int8_t largerBetter)
virtual StatisticDescriptor^	CreateIntCounter (String^ name, String^ description, String^ units)
virtual StatisticDescriptor^	CreateIntCounter (String^ name, String^ description, String^ units, int8_t largerBetter)
virtual StatisticDescriptor^	CreateIntGauge (String^ name, String^ description, String^ units)
virtual StatisticDescriptor^	CreateIntGauge (String^ name, String^ description, String^ units, int8_t largerBetter)
virtual StatisticDescriptor^	CreateLongCounter (String^ name, String^ description, String^ units)
virtual StatisticDescriptor^	CreateLongCounter (String^ name, String^ description, String^ units, int8_t largerBetter)
virtual StatisticDescriptor^	CreateLongGauge (String^ name, String^ description, String^ units)
virtual StatisticDescriptor^	CreateLongGauge (String^ name, String^ description, String^ units, int8_t largerBetter)
virtual Statistics^	CreateStatistics (StatisticsType^ type, String^ textId, int64_t numericId)
virtual Statistics^	CreateStatistics (StatisticsType^ type, String^ textId)
virtual Statistics^	CreateStatistics (StatisticsType^ type)
virtual StatisticsType^	CreateType (String^ name, String^ description, array< StatisticDescriptor^ >^stats, int32 statsLength)
virtual Statistics^	FindFirstStatisticsByType (StatisticsType^ type)
virtual StatisticsType^	FindType (String^ name)
Static Public Member Functions
static StatisticsFactory^	GetExistingInstance ()
Properties
virtual int64_t	ID [get]
virtual String^	Name [get]

---

Member Function Documentation

virtual Statistics ^ GemStone::GemFire::Cache::StatisticsFactory::CreateAtomicStatistics	(	StatisticsType^	type,
		String^	textId,
		int64	numericId
	)			[virtual]

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

The created instance will be Statistics::isAtomic atomic.

virtual Statistics ^ GemStone::GemFire::Cache::StatisticsFactory::CreateAtomicStatistics	(	StatisticsType^	type,
		String^	textId
	)			[virtual]

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

The created instance will be Statistics::isAtomic atomic.

virtual Statistics ^ GemStone::GemFire::Cache::StatisticsFactory::CreateAtomicStatistics

(

StatisticsType^

type

)

[virtual]

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

The created instance will be Statistics::isAtomic atomic.

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateDoubleCounter	(	String^	name,
		String^	description,
		String^	units
	)			[virtual]

Creates and returns an double counter StatisticDescriptor with the given name, description, units.

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateDoubleCounter	(	String^	name,
		String^	description,
		String^	units,
		int8_t	largerBetter
	)			[virtual]

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

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateDoubleGauge	(	String^	name,
		String^	description,
		String^	units
	)			[virtual]

Creates and returns an double gauge StatisticDescriptor with the given name, description, units.

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateDoubleGauge	(	String^	name,
		String^	description,
		String^	units,
		int8_t	largerBetter
	)			[virtual]

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

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateIntCounter	(	String^	name,
		String^	description,
		String^	units
	)			[virtual]

Creates and returns an int counter StatisticDescriptor with the given name, description, units.

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateIntCounter	(	String^	name,
		String^	description,
		String^	units,
		int8_t	largerBetter
	)			[virtual]

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

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateIntGauge	(	String^	name,
		String^	description,
		String^	units
	)			[virtual]

Creates and returns an int gauge StatisticDescriptor with the given name, description, units.

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateIntGauge	(	String^	name,
		String^	description,
		String^	units,
		int8_t	largerBetter
	)			[virtual]

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

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateLongCounter	(	String^	name,
		String^	description,
		String^	units
	)			[virtual]

Creates and returns an long counter StatisticDescriptor with the given name, description, units.

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateLongCounter	(	String^	name,
		String^	description,
		String^	units,
		int8_t	largerBetter
	)			[virtual]

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

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateLongGauge	(	String^	name,
		String^	description,
		String^	units
	)			[virtual]

Creates and returns an long gauge StatisticDescriptor with the given name, description, units.

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::StatisticsFactory::CreateLongGauge	(	String^	name,
		String^	description,
		String^	units,
		int8_t	largerBetter
	)			[virtual]

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

virtual Statistics ^ GemStone::GemFire::Cache::StatisticsFactory::CreateStatistics	(	StatisticsType^	type,
		String^	textId,
		int64_t	numericId
	)			[virtual]

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

The created instance may not be Statistics::isAtomic atomic.

virtual Statistics ^ GemStone::GemFire::Cache::StatisticsFactory::CreateStatistics	(	StatisticsType^	type,
		String^	textId
	)			[virtual]

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

The created instance may not be Statistics::isAtomic atomic.

virtual Statistics ^ GemStone::GemFire::Cache::StatisticsFactory::CreateStatistics

(

StatisticsType^

type

)

[virtual]

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

The created instance may not be Statistics::isAtomic atomic.

virtual StatisticsType ^ GemStone::GemFire::Cache::StatisticsFactory::CreateType	(	String^	name,
		String^	description,
		array< StatisticDescriptor^ >^	stats,
		int32	statsLength
	)			[virtual]

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 ^ GemStone::GemFire::Cache::StatisticsFactory::FindFirstStatisticsByType

(

StatisticsType^

type

)

[virtual]

Return the first instance that matches the type, or NULL

virtual StatisticsType ^ GemStone::GemFire::Cache::StatisticsFactory::FindType

(

String^

name

)

[virtual]

Finds and returns an already created StatisticsType with the given name. Returns null if the type does not exist.

static StatisticsFactory ^ GemStone::GemFire::Cache::StatisticsFactory::GetExistingInstance

(

)

[static]

Return a pre-existing statistics factory. Typically configured through creation of a distributed system.

---

Property Documentation

virtual int64_t GemStone::GemFire::Cache::StatisticsFactory::ID [get]

Returns a numeric id that can be used to identify the manager

virtual String^ GemStone::GemFire::Cache::StatisticsFactory::Name [get]

Returns a name that can be used to identify the manager

---