VMware GemFire Native .NET Reference  9.2.4
Public Member Functions | Static Public Member Functions | Properties
Apache::Geode::Client::StatisticsFactory Class Reference

Instances of this interface provide methods that create instances of StatisticDescriptor and StatisticsType. More...

Inherits UMWrap< apache::geode::statistics::StatisticsFactory >.

Public Member Functions

virtual Statistics ^ CreateAtomicStatistics (StatisticsType^ type)
 Creates and returns a Statistics instance of the given StatisticsType type, textId, and with default ids. More...
 
virtual Statistics ^ CreateAtomicStatistics (StatisticsType^ type, String^ textId)
 Creates and returns a Statistics instance of the given StatisticsType type, textId, and with a default numeric id. More...
 
virtual Statistics ^ CreateAtomicStatistics (StatisticsType^ type, String^ textId, System::Int64 numericId)
 Creates and returns a Statistics instance of the given StatisticsType type, textId, and numericId. More...
 
virtual StatisticDescriptor ^ CreateDoubleCounter (String^ name, String^ description, String^ units)
 Creates and returns an double counter StatisticDescriptor with the given name, description, units. More...
 
virtual StatisticDescriptor ^ CreateDoubleCounter (String^ name, String^ description, String^ units, int8_t largerBetter)
 Creates and returns an double counter StatisticDescriptor with the given name, description, units, and with larger values indicating better performance. More...
 
virtual StatisticDescriptor ^ CreateDoubleGauge (String^ name, String^ description, String^ units)
 Creates and returns an double gauge StatisticDescriptor with the given name, description, units. More...
 
virtual StatisticDescriptor ^ CreateDoubleGauge (String^ name, String^ description, String^ units, int8_t largerBetter)
 Creates and returns an double gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance. More...
 
virtual StatisticDescriptor ^ CreateIntCounter (String^ name, String^ description, String^ units)
 Creates and returns an int counter StatisticDescriptor with the given name, description, units. More...
 
virtual StatisticDescriptor ^ CreateIntCounter (String^ name, String^ description, String^ units, int8_t largerBetter)
 Creates and returns an int counter StatisticDescriptor with the given name, description, units, and with larger values indicating better performance. More...
 
virtual StatisticDescriptor ^ CreateIntGauge (String^ name, String^ description, String^ units)
 Creates and returns an int gauge StatisticDescriptor with the given name, description, units. More...
 
virtual StatisticDescriptor ^ CreateIntGauge (String^ name, String^ description, String^ units, int8_t largerBetter)
 Creates and returns an int gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance. More...
 
virtual StatisticDescriptor ^ CreateLongCounter (String^ name, String^ description, String^ units)
 Creates and returns an long counter StatisticDescriptor with the given name, description, units. More...
 
virtual StatisticDescriptor ^ CreateLongCounter (String^ name, String^ description, String^ units, int8_t largerBetter)
 Creates and returns an long counter StatisticDescriptor with the given name, description, units, and with larger values indicating better performance. More...
 
virtual StatisticDescriptor ^ CreateLongGauge (String^ name, String^ description, String^ units)
 Creates and returns an long gauge StatisticDescriptor with the given name, description, units. More...
 
virtual StatisticDescriptor ^ CreateLongGauge (String^ name, String^ description, String^ units, int8_t largerBetter)
 Creates and returns an long gauge StatisticDescriptor with the given name, description, units, and with smaller values indicating better performance. More...
 
virtual Statistics ^ CreateStatistics (StatisticsType^ type)
 Creates and returns a Statistics instance of the given StatisticsType type, textId, and with default ids. More...
 
virtual Statistics ^ CreateStatistics (StatisticsType^ type, String^ textId)
 Creates and returns a Statistics instance of the given StatisticsType type, textId, and with a default numeric id. More...
 
virtual Statistics ^ CreateStatistics (StatisticsType^ type, String^ textId, System::Int64 numericId)
 Creates and returns a Statistics instance of the given StatisticsType type, textId, and numericId. More...
 
virtual StatisticsType ^ CreateType (String^ name, String^ description, array< StatisticDescriptor^>^ stats, System::Int32 statsLength)
 Creates and returns a StatisticsType with the given name, description,and StatisticDescriptor More...
 
virtual Statistics ^ FindFirstStatisticsByType (StatisticsType^ type)
 Return the first instance that matches the type, or NULL More...
 
virtual StatisticsType ^ FindType (String^ name)
 Finds and returns an already created StatisticsType with the given name. More...
 

Static Public Member Functions

static StatisticsFactory ^ GetExistingInstance ()
 Return a pre-existing statistics factory. More...
 

Properties

virtual System::Int64 ID [get]
 Returns a numeric id that can be used to identify the manager More...
 
virtual String^ Name [get]
 Returns a name that can be used to identify the manager More...
 

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 Geode Manager Console to properly display a statistics whose value "wraps around" (that is, exceeds its maximum value).

Member Function Documentation

◆ CreateAtomicStatistics() [1/3]

virtual Statistics ^ Apache::Geode::Client::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.

◆ CreateAtomicStatistics() [2/3]

virtual Statistics ^ Apache::Geode::Client::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.

◆ CreateAtomicStatistics() [3/3]

virtual Statistics ^ Apache::Geode::Client::StatisticsFactory::CreateAtomicStatistics ( StatisticsType^  type,
String^  textId,
System::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.

◆ CreateDoubleCounter() [1/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::StatisticsFactory::CreateDoubleCounter ( String^  name,
String^  description,
String^  units 
)
virtual

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

◆ CreateDoubleCounter() [2/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::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.

◆ CreateDoubleGauge() [1/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::StatisticsFactory::CreateDoubleGauge ( String^  name,
String^  description,
String^  units 
)
virtual

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

◆ CreateDoubleGauge() [2/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::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.

◆ CreateIntCounter() [1/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::StatisticsFactory::CreateIntCounter ( String^  name,
String^  description,
String^  units 
)
virtual

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

◆ CreateIntCounter() [2/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::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.

◆ CreateIntGauge() [1/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::StatisticsFactory::CreateIntGauge ( String^  name,
String^  description,
String^  units 
)
virtual

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

◆ CreateIntGauge() [2/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::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.

◆ CreateLongCounter() [1/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::StatisticsFactory::CreateLongCounter ( String^  name,
String^  description,
String^  units 
)
virtual

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

◆ CreateLongCounter() [2/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::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.

◆ CreateLongGauge() [1/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::StatisticsFactory::CreateLongGauge ( String^  name,
String^  description,
String^  units 
)
virtual

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

◆ CreateLongGauge() [2/2]

virtual StatisticDescriptor ^ Apache::Geode::Client::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.

◆ CreateStatistics() [1/3]

virtual Statistics ^ Apache::Geode::Client::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.

◆ CreateStatistics() [2/3]

virtual Statistics ^ Apache::Geode::Client::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.

◆ CreateStatistics() [3/3]

virtual Statistics ^ Apache::Geode::Client::StatisticsFactory::CreateStatistics ( StatisticsType^  type,
String^  textId,
System::Int64  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.

◆ CreateType()

virtual StatisticsType ^ Apache::Geode::Client::StatisticsFactory::CreateType ( String^  name,
String^  description,
array< StatisticDescriptor^>^  stats,
System::Int32  statsLength 
)
virtual

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

Exceptions
IllegalArgumentExceptionif a type with the given name already exists.

◆ FindFirstStatisticsByType()

virtual Statistics ^ Apache::Geode::Client::StatisticsFactory::FindFirstStatisticsByType ( StatisticsType^  type)
virtual

Return the first instance that matches the type, or NULL

◆ FindType()

virtual StatisticsType ^ Apache::Geode::Client::StatisticsFactory::FindType ( String^  name)
virtual

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

Returns null if the type does not exist.

◆ GetExistingInstance()

static StatisticsFactory ^ Apache::Geode::Client::StatisticsFactory::GetExistingInstance ( )
static

Return a pre-existing statistics factory.

Typically configured through creation of a distributed system.

Property Documentation

◆ ID

virtual System:: Int64 Apache::Geode::Client::StatisticsFactory::ID
get

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

◆ Name

virtual String^ Apache::Geode::Client::StatisticsFactory::Name
get

Returns a name that can be used to identify the manager

VMware GemFire .NET Cache API Documentation