GemStone::GemFire::Cache::Generic::Statistics Class Reference

Inherits GemStone::GemFire::Cache::Generic::Internal::UMWrapN< gemfire_statistics::Statistics >.


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.

Public Member Functions

virtual void Close ()
virtual double GetDouble (String^ name)
virtual double GetDouble (StatisticDescriptor^ descriptor)
virtual double GetDouble (int32_t id)
virtual int32_t GetInt (String^ name)
virtual int32_t GetInt (StatisticDescriptor^ descriptor)
virtual int32_t GetInt (int32_t id)
virtual int64_t GetLong (String^ name)
virtual int64_t GetLong (StatisticDescriptor^ descriptor)
virtual int64_t GetLong (int32_t id)
virtual int64_t GetRawBits (StatisticDescriptor^ descriptor)
virtual double IncDouble (String^ name, double delta)
virtual double IncDouble (StatisticDescriptor^ descriptor, double delta)
virtual double IncDouble (int32_t id, double delta)
virtual int32_t IncInt (String^ name, int32_t delta)
virtual int32_t IncInt (StatisticDescriptor^ descriptor, int32_t delta)
virtual int32_t IncInt (int32_t id, int32_t delta)
virtual int64_t IncLong (String^ name, int64_t delta)
virtual int64_t IncLong (StatisticDescriptor^ descriptor, int64_t delta)
virtual int64_t IncLong (int32_t id, int64_t delta)
virtual
StatisticDescriptor
NameToDescriptor (String^ name)
virtual int32_t NameToId (String^ name)
virtual void SetDouble (StatisticDescriptor^ descriptor, double value)
virtual void SetDouble (String^ name, double value)
virtual void SetDouble (int32_t id, double value)
virtual void SetInt (StatisticDescriptor^ descriptor, int32_t value)
virtual void SetInt (String^ name, int32_t value)
virtual void SetInt (int32_t id, int32_t value)
virtual void SetLong (String^ name, int64_t value)
virtual void SetLong (StatisticDescriptor^ descriptor, int64_t value)
virtual void SetLong (int32_t id, int64_t value)

Protected Member Functions

void InternalCleanup ()
void SetPtr (gemfire_statistics::Statistics *nativeptr, bool own)

Properties

virtual bool IsAtomic [get]
virtual bool IsClosed [get]
virtual bool IsShared [get]
virtual int64_t NumericId [get]
bool Own [get, set]
virtual String^  TextId [get]
virtual StatisticsType^  Type [get]
virtual int64_t UniqueId [get]


Member Function Documentation

virtual void GemStone::GemFire::Cache::Generic::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.

virtual double GemStone::GemFire::Cache::Generic::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.

virtual double GemStone::GemFire::Cache::Generic::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.

virtual double GemStone::GemFire::Cache::Generic::Statistics::GetDouble ( int32_t  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.

virtual int32_t GemStone::GemFire::Cache::Generic::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.

virtual int32_t GemStone::GemFire::Cache::Generic::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.

virtual int32_t GemStone::GemFire::Cache::Generic::Statistics::GetInt ( int32_t  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.

virtual int64_t GemStone::GemFire::Cache::Generic::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.

virtual int64_t GemStone::GemFire::Cache::Generic::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.

virtual int64_t GemStone::GemFire::Cache::Generic::Statistics::GetLong ( int32_t  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.

virtual int64_t GemStone::GemFire::Cache::Generic::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

virtual double GemStone::GemFire::Cache::Generic::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.

virtual double GemStone::GemFire::Cache::Generic::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.

virtual double GemStone::GemFire::Cache::Generic::Statistics::IncDouble ( int32_t  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.

virtual int32_t GemStone::GemFire::Cache::Generic::Statistics::IncInt ( String^   name,
int32_t  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.

virtual int32_t GemStone::GemFire::Cache::Generic::Statistics::IncInt ( StatisticDescriptor^   descriptor,
int32_t  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.

virtual int32_t GemStone::GemFire::Cache::Generic::Statistics::IncInt ( int32_t  id,
int32_t  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.

virtual int64_t GemStone::GemFire::Cache::Generic::Statistics::IncLong ( String^   name,
int64_t  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.

virtual int64_t GemStone::GemFire::Cache::Generic::Statistics::IncLong ( StatisticDescriptor^   descriptor,
int64_t  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.

virtual int64_t GemStone::GemFire::Cache::Generic::Statistics::IncLong ( int32_t  id,
int64_t  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.

void GemStone::GemFire::Cache::Generic::Internal::UMWrapN< gemfire_statistics::Statistics >::InternalCleanup (  )  [inline, protected, inherited]

Internal cleanup function invoked by dispose/finalizer.

virtual StatisticDescriptor ^ GemStone::GemFire::Cache::Generic::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

virtual int32_t GemStone::GemFire::Cache::Generic::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

virtual void GemStone::GemFire::Cache::Generic::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.

virtual void GemStone::GemFire::Cache::Generic::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.

virtual void GemStone::GemFire::Cache::Generic::Statistics::SetDouble ( int32_t  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.

virtual void GemStone::GemFire::Cache::Generic::Statistics::SetInt ( StatisticDescriptor^   descriptor,
int32_t  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.

virtual void GemStone::GemFire::Cache::Generic::Statistics::SetInt ( String^   name,
int32_t  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.

virtual void GemStone::GemFire::Cache::Generic::Statistics::SetInt ( int32_t  id,
int32_t  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.

virtual void GemStone::GemFire::Cache::Generic::Statistics::SetLong ( String^   name,
int64_t  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.

virtual void GemStone::GemFire::Cache::Generic::Statistics::SetLong ( StatisticDescriptor^   descriptor,
int64_t  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.

virtual void GemStone::GemFire::Cache::Generic::Statistics::SetLong ( int32_t  id,
int64_t  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.

void GemStone::GemFire::Cache::Generic::Internal::UMWrapN< gemfire_statistics::Statistics >::SetPtr ( gemfire_statistics::Statistics *  nativeptr,
bool  own 
) [inline, protected, inherited]

Used to set the native pointer to a new object. This should only be used when you know that the underlying object is NULL or you do not own it.


Property Documentation

virtual bool GemStone::GemFire::Cache::Generic::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.

virtual bool GemStone::GemFire::Cache::Generic::Statistics::IsClosed [get]

Returns true if the instance has been close closed.

virtual bool GemStone::GemFire::Cache::Generic::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.

virtual int64_t GemStone::GemFire::Cache::Generic::Statistics::NumericId [get]

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

bool GemStone::GemFire::Cache::Generic::Internal::UMWrapN< gemfire_statistics::Statistics >::Own [get, set, protected, inherited]

Get or set the ownership of this object.

Returns:
True if the native object is owned by this object.

virtual String^ GemStone::GemFire::Cache::Generic::Statistics::TextId [get]

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

virtual StatisticsType^ GemStone::GemFire::Cache::Generic::Statistics::Type [get]

Gets the StatisticsType of this instance.

virtual int64_t GemStone::GemFire::Cache::Generic::Statistics::UniqueId [get]

Gets a value that uniquely identifies this statistics.


GemFire C++ Cache .NET API Documentation