Apache::Geode::Client::Statistics Class Reference

An instantiation of an existing StatisticsType object with methods for setting, incrementing and getting individual StatisticDescriptor values. More...

Inherits UMWrapN< apache::geode::statistics::Statistics >.

Public Member Functions
virtual void	Close ()
	Closes these statistics. More...
virtual double	GetDouble (StatisticDescriptor^ descriptor)
	Returns the value of the described statistic of type double. More...
virtual double	GetDouble (String^ name)
	Returns the value of the statistic of type double at the given name. More...
virtual double	GetDouble (System::Int32 id)
	Returns the value of the identified statistic of type double. More...
virtual System::Int32	GetInt (StatisticDescriptor^ descriptor)
	Returns the value of the described statistic of type int . More...
virtual System::Int32	GetInt (String^ name)
	Returns the value of the statistic of type int at the given name. More...
virtual System::Int32	GetInt (System::Int32 id)
	Returns the value of the identified statistic of type int. More...
virtual System::Int64	GetLong (StatisticDescriptor^ descriptor)
	Returns the value of the described statistic of type long. More...
virtual System::Int64	GetLong (String^ name)
	Returns the value of the statistic of type long at the given name. More...
virtual System::Int64	GetLong (System::Int32 id)
	Returns the value of the identified statistic of type long. More...
virtual System::Int64	GetRawBits (StatisticDescriptor^ descriptor)
	Returns the bits that represent the raw value of the described statistic. More...
virtual double	IncDouble (StatisticDescriptor^ descriptor, double delta)
	Increments the value of the described statistic of type double by the given amount. More...
virtual double	IncDouble (String^ name, double delta)
	Increments the value of the statistic of type double with the given name by a given amount. More...
virtual double	IncDouble (System::Int32 id, double delta)
	Increments the value of the identified statistic of type double by the given amount. More...
virtual System::Int32	IncInt (StatisticDescriptor^ descriptor, System::Int32 delta)
	Increments the value of the described statistic of type int by the given amount. More...
virtual System::Int32	IncInt (String^ name, System::Int32 delta)
	Increments the value of the statistic of type int with the given name by a given amount. More...
virtual System::Int32	IncInt (System::Int32 id, System::Int32 delta)
	Increments the value of the identified statistic of type int by the given amount. More...
virtual System::Int64	IncLong (StatisticDescriptor^ descriptor, System::Int64 delta)
	Increments the value of the described statistic of type long by the given amount. More...
virtual System::Int64	IncLong (String^ name, System::Int64 delta)
	Increments the value of the statistic of type long with the given name by a given amount. More...
virtual System::Int64	IncLong (System::Int32 id, System::Int64 delta)
	Increments the value of the identified statistic of type long by the given amount. More...
virtual StatisticDescriptor ^	NameToDescriptor (String^ name)
	Returns the descriptor of the statistic with the given name in this statistics instance. More...
virtual System::Int32	NameToId (String^ name)
	Returns the id of the statistic with the given name in this statistics instance. More...
virtual void	SetDouble (StatisticDescriptor^ descriptor, double value)
	Sets the value of a described statistic of type double More...
virtual void	SetDouble (String^ name, double value)
	Sets the value of a named statistic of type double More...
virtual void	SetDouble (System::Int32 id, double value)
	Sets the value of a statistic with the given id whose type is double. More...
virtual void	SetInt (StatisticDescriptor^ descriptor, System::Int32 value)
	Sets the value of a described statistic of type int More...
virtual void	SetInt (String^ name, System::Int32 value)
	Sets the value of a named statistic of type int More...
virtual void	SetInt (System::Int32 id, System::Int32 value)
	Sets the value of a statistic with the given id whose type is int. More...
virtual void	SetLong (StatisticDescriptor^ descriptor, System::Int64 value)
	Sets the value of a described statistic of type long More...
virtual void	SetLong (String^ name, System::Int64 value)
	Sets the value of a named statistic of type long. More...
virtual void	SetLong (System::Int32 id, System::Int64 value)
	Sets the value of a statistic with the given id whose type is long. More...

Properties
virtual bool	IsAtomic [get]
	Returns true if modifications are atomic. More...
virtual bool	IsClosed [get]
	Returns true if the instance has been #close closed. More...
virtual bool	IsShared [get]
	Returns true if the data for this instance is stored in shared memory. More...
virtual System::Int64	NumericId [get]
	Gets the number associated with this instance that helps identify it. More...
virtual String^	TextId [get]
	Gets the text associated with this instance that helps identify it. More...
virtual StatisticsType^	Type [get]
	Gets the StatisticsType of this instance. More...
virtual System::Int64	UniqueId [get]
	Gets a value that uniquely identifies this statistics. More...

Detailed Description

An instantiation of an existing StatisticsType object with methods for setting, incrementing and getting individual StatisticDescriptor values.

The class is purposefully inherited from UMWrapN and not UMWrap as the destructor of the class is protected, and so it is now not called from inside the InternalCleanup method.

Member Function Documentation

Close()

virtual void Apache::Geode::Client::Statistics::Close ( )

virtual

Closes these statistics.

After statistics have been closed, they are no longer archived. A value access on a closed statistics always results in zero. A value modification on a closed statistics is ignored.

GetDouble() [1/3]

virtual double Apache::Geode::Client::Statistics::GetDouble ( StatisticDescriptor^  descriptor )

virtual

Returns the value of the described statistic of type double.

Parameters

descriptor

a statistic descriptor obtained with #nameToDescriptor or StatisticsType::nameToDescriptor

Exceptions

IllegalArgumentException

If no statistic exists with the specified descriptor or if the described statistic is not of type double.

GetDouble() [2/3]

virtual double Apache::Geode::Client::Statistics::GetDouble ( String^  name )

virtual

Returns the value of the statistic of type double at the given name.

Parameters

name	statistic name

Exceptions

IllegalArgumentException

If no statistic exists named name or if the statistic with name name is not of type double.

GetDouble() [3/3]

virtual double Apache::Geode::Client::Statistics::GetDouble ( System::Int32  id )

virtual

Returns the value of the identified statistic of type double.

Parameters

id	a statistic id obtained with #nameToId or #StatisticsType#nameToId

Exceptions

IllegalArgumentException

If the id is invalid.

GetInt() [1/3]

virtual System::Int32 Apache::Geode::Client::Statistics::GetInt ( StatisticDescriptor^  descriptor )

virtual

Returns the value of the described statistic of type

int

.

Parameters

descriptor

a statistic descriptor obtained with #nameToDescriptor or StatisticsType::nameToDescriptor

Exceptions

IllegalArgumentException

If no statistic exists with the specified descriptor or if the described statistic is not of type int.

GetInt() [2/3]

virtual System::Int32 Apache::Geode::Client::Statistics::GetInt ( String^  name )

virtual

Returns the value of the statistic of type

int

at the given name.

Parameters

name	statistic name

Exceptions

IllegalArgumentException

If no statistic exists named name or if the statistic with name name is not of type int.

GetInt() [3/3]

virtual System::Int32 Apache::Geode::Client::Statistics::GetInt ( System::Int32  id )

virtual

Returns the value of the identified statistic of type int.

whose type is double.

Parameters

id	a statistic id obtained with #nameToId or #StatisticsType#nameToId

Exceptions

IllegalArgumentException

If the id is invalid.

GetLong() [1/3]

virtual System::Int64 Apache::Geode::Client::Statistics::GetLong ( StatisticDescriptor^  descriptor )

virtual

Returns the value of the described statistic of type long.

Parameters

descriptor

a statistic descriptor obtained with #nameToDescriptor or StatisticsType::nameToDescriptor

Exceptions

IllegalArgumentException

If no statistic exists with the specified descriptor or if the described statistic is not of type long.

GetLong() [2/3]

virtual System::Int64 Apache::Geode::Client::Statistics::GetLong ( String^  name )

virtual

Returns the value of the statistic of type long at the given name.

Parameters

name	statistic name

Exceptions

IllegalArgumentException

If no statistic exists named name or if the statistic with name name is not of type long.

GetLong() [3/3]

virtual System::Int64 Apache::Geode::Client::Statistics::GetLong ( System::Int32  id )

virtual

Returns the value of the identified statistic of type long.

Parameters

id	a statistic id obtained with #nameToId or #StatisticsType#nameToId

Exceptions

IllegalArgumentException

If the id is invalid.

GetRawBits()

virtual System::Int64 Apache::Geode::Client::Statistics::GetRawBits ( StatisticDescriptor^  descriptor )

virtual

Returns the bits that represent the raw value of the described statistic.

Parameters

descriptor

a statistic descriptor obtained with #nameToDescriptor or StatisticsType::nameToDescriptor

Exceptions

IllegalArgumentException

If the described statistic does not exist

IncDouble() [1/3]

virtual double Apache::Geode::Client::Statistics::IncDouble ( StatisticDescriptor^  descriptor, double  delta  )

virtual

Increments the value of the described statistic of type double by the given amount.

Parameters

descriptor	a statistic descriptor obtained with #nameToDescriptor or StatisticsType::nameToDescriptor
delta	change value to be added

Returns

the value of the statistic after it has been incremented

Exceptions

IllegalArgumentException

If no statistic exists for the given descriptor or if the described statistic is not of type double.

IncDouble() [2/3]

virtual double Apache::Geode::Client::Statistics::IncDouble ( String^  name, double  delta  )

virtual

Increments the value of the statistic of type double with the given name by a given amount.

Parameters

name	statistic name
delta	change value to be added

Returns

the value of the statistic after it has been incremented

Exceptions

IllegalArgumentException

If no statistic exists named name or if the statistic with name name is not of type double.

IncDouble() [3/3]

virtual double Apache::Geode::Client::Statistics::IncDouble ( System::Int32  id, double  delta  )

virtual

Increments the value of the identified statistic of type double by the given amount.

Parameters

id	a statistic id obtained with #nameToId or #StatisticsType#nameToId
delta	the value of the statistic after it has been incremented

Returns

the value of the statistic after it has been incremented

Exceptions

IllegalArgumentException

If the id is invalid.

IncInt() [1/3]

virtual System::Int32 Apache::Geode::Client::Statistics::IncInt ( StatisticDescriptor^  descriptor, System::Int32  delta  )

virtual

Increments the value of the described statistic of type int by the given amount.

Parameters

descriptor	a statistic descriptor obtained with #nameToDescriptor or StatisticsType::nameToDescriptor
delta	change value to be added

Returns

the value of the statistic after it has been incremented

Exceptions

IllegalArgumentException

If no statistic exists for the given descriptor or if the described statistic is not of type int.

IncInt() [2/3]

virtual System::Int32 Apache::Geode::Client::Statistics::IncInt ( String^  name, System::Int32  delta  )

virtual

Increments the value of the statistic of type int with the given name by a given amount.

Parameters

name	statistic name
delta	change value to be added

Returns

the value of the statistic after it has been incremented

Exceptions

IllegalArgumentException

If no statistic exists named name or if the statistic with name name is not of type int.

IncInt() [3/3]

virtual System::Int32 Apache::Geode::Client::Statistics::IncInt ( System::Int32  id, System::Int32  delta  )

virtual

Increments the value of the identified statistic of type int by the given amount.

Parameters

id	a statistic id obtained with #nameToId or #StatisticsType#nameToId
delta	the value of the statistic after it has been incremented

Returns

the value of the statistic after it has been incremented

Exceptions

IllegalArgumentException

If the id is invalid.

IncLong() [1/3]

virtual System::Int64 Apache::Geode::Client::Statistics::IncLong ( StatisticDescriptor^  descriptor, System::Int64  delta  )

virtual

Increments the value of the described statistic of type long by the given amount.

Parameters

descriptor	a statistic descriptor obtained with #nameToDescriptor or StatisticsType::nameToDescriptor
delta	change value to be added

Returns

the value of the statistic after it has been incremented

Exceptions

IllegalArgumentException

If no statistic exists for the given descriptor or if the described statistic is not of type long.

IncLong() [2/3]

virtual System::Int64 Apache::Geode::Client::Statistics::IncLong ( String^  name, System::Int64  delta  )

virtual

Increments the value of the statistic of type long with the given name by a given amount.

Parameters

name	statistic name
delta	change value to be added

Returns

the value of the statistic after it has been incremented

Exceptions

IllegalArgumentException

If no statistic exists named name or if the statistic with name name is not of type long.

IncLong() [3/3]

virtual System::Int64 Apache::Geode::Client::Statistics::IncLong ( System::Int32  id, System::Int64  delta  )

virtual

Increments the value of the identified statistic of type long by the given amount.

Parameters

id	a statistic id obtained with #nameToId or #StatisticsType#nameToId
delta	the value of the statistic after it has been incremented

Returns

the value of the statistic after it has been incremented

Exceptions

IllegalArgumentException

If the id is invalid.

NameToDescriptor()

virtual StatisticDescriptor ^ Apache::Geode::Client::Statistics::NameToDescriptor ( String^  name )

virtual

Returns the descriptor of the statistic with the given name in this statistics instance.

Parameters

name	the statistic name

Returns

the descriptor of the statistic with the given name

Exceptions

IllegalArgumentException

if no statistic named name exists in this statistics instance.

StatisticsType::nameToId

NameToId()

virtual System::Int32 Apache::Geode::Client::Statistics::NameToId ( String^  name )

virtual

Returns the id of the statistic with the given name in this statistics instance.

Parameters

name	the statistic name

Returns

the id of the statistic with the given name

Exceptions

IllegalArgumentException

if no statistic named name exists in this statistics instance.

StatisticsType::nameToDescriptor

SetDouble() [1/3]

virtual void Apache::Geode::Client::Statistics::SetDouble ( StatisticDescriptor^  descriptor, double  value  )

virtual

Sets the value of a described statistic of type double

Parameters

descriptor	a statistic descriptor obtained with #nameToDescriptor or StatisticsType::nameToDescriptor
value	value to set

Exceptions

IllegalArgumentException

If no statistic exists for the given descriptor or if the described statistic is not of type double.

SetDouble() [2/3]

virtual void Apache::Geode::Client::Statistics::SetDouble ( String^  name, double  value  )

virtual

Sets the value of a named statistic of type double

Parameters

name	statistic name
value	value to set

Exceptions

IllegalArgumentException

If no statistic exists named name or if the statistic with name name is not of type double.

SetDouble() [3/3]

virtual void Apache::Geode::Client::Statistics::SetDouble ( System::Int32  id, double  value  )

virtual

Sets the value of a statistic with the given id whose type is double.

Parameters

id	a statistic id obtained with #nameToId or #StatisticsType#nameToId
value	value to set

Exceptions

IllegalArgumentException

If the id is invalid.

SetInt() [1/3]

virtual void Apache::Geode::Client::Statistics::SetInt ( StatisticDescriptor^  descriptor, System::Int32  value  )

virtual

Sets the value of a described statistic of type int

Parameters

descriptor	a statistic descriptor obtained with #nameToDescriptor or #StatisticsType#nameToDescriptor
value	value to set

Exceptions

IllegalArgumentException

If no statistic exists for the given descriptor or if the described statistic is not of type int.

SetInt() [2/3]

virtual void Apache::Geode::Client::Statistics::SetInt ( String^  name, System::Int32  value  )

virtual

Sets the value of a named statistic of type int

Parameters

name	statistic name
value	value to set

Exceptions

IllegalArgumentException

If no statistic exists named name or if the statistic with name name is not of type int.

SetInt() [3/3]

virtual void Apache::Geode::Client::Statistics::SetInt ( System::Int32  id, System::Int32  value  )

virtual

Sets the value of a statistic with the given id whose type is int.

Parameters

id	a statistic id obtained with #nameToId or #StatisticsType#nameToId
value	value to set

Exceptions

IllegalArgumentException

If the id is invalid.

SetLong() [1/3]

virtual void Apache::Geode::Client::Statistics::SetLong ( StatisticDescriptor^  descriptor, System::Int64  value  )

virtual

Sets the value of a described statistic of type long

Parameters

descriptor	a statistic descriptor obtained with #nameToDescriptor or StatisticsType::nameToDescriptor
value	value to set

Exceptions

IllegalArgumentException

If no statistic exists for the given descriptor or if the described statistic is not of type long.

SetLong() [2/3]

virtual void Apache::Geode::Client::Statistics::SetLong ( String^  name, System::Int64  value  )

virtual

Sets the value of a named statistic of type long.

Parameters

name	statistic name
value	value to set

Exceptions

IllegalArgumentException

If no statistic exists named name or if the statistic with name name is not of type long.

SetLong() [3/3]

virtual void Apache::Geode::Client::Statistics::SetLong ( System::Int32  id, System::Int64  value  )

virtual

Sets the value of a statistic with the given id whose type is long.

Parameters

id	a statistic id obtained with #nameToId or #StatisticsType#nameToId.
value	value to set

Exceptions

IllegalArgumentException

If the id is invalid.

Property Documentation

IsAtomic

virtual bool Apache::Geode::Client::Statistics::IsAtomic

get

Returns true if modifications are atomic.

This means that multiple threads can safely modify this instance without additional synchronization.

Returns false if modifications are not atomic. This means that modifications to this instance are cheaper but not thread safe.

Note that all instances that are #isShared shared are also atomic.

IsClosed

virtual bool Apache::Geode::Client::Statistics::IsClosed

get

Returns true if the instance has been #close closed.

IsShared

virtual bool Apache::Geode::Client::Statistics::IsShared

get

Returns true if the data for this instance is stored in shared memory.

Returns false if the data is store in local memory.

Note that all instances that are #isShared shared are also atomic.

NumericId

virtual System:: Int64 Apache::Geode::Client::Statistics::NumericId

get

Gets the number associated with this instance that helps identify it.

TextId

virtual String^ Apache::Geode::Client::Statistics::TextId

get

Gets the text associated with this instance that helps identify it.

Type

virtual StatisticsType^ Apache::Geode::Client::Statistics::Type

get

Gets the StatisticsType of this instance.

UniqueId

virtual System:: Int64 Apache::Geode::Client::Statistics::UniqueId

get

Gets a value that uniquely identifies this statistics.