StatisticsType object with methods for setting, incrementing and getting individual StatisticDescriptor values. Public Member Functions | |
| virtual void | close ()=0 |
| Closes these statistics. | |
| virtual double | getDouble (char *name)=0 |
Returns the value of the statistic of type double at the given name. | |
| virtual double | getDouble (StatisticDescriptor *descriptor)=0 |
Returns the value of the described statistic of type double. | |
| virtual double | getDouble (int32 id)=0 |
Returns the value of the identified statistic of type double. | |
| virtual int32 | getInt (char *name)=0 |
Returns the value of the statistic of type int at the given name. | |
| virtual int32 | getInt (StatisticDescriptor *descriptor)=0 |
Returns the value of the described statistic of type int. | |
| virtual int32 | getInt (int32 id)=0 |
Returns the value of the identified statistic of type int. | |
| virtual int64 | getLong (char *name)=0 |
Returns the value of the statistic of type long at the given name. | |
| virtual int64 | getLong (StatisticDescriptor *descriptor)=0 |
Returns the value of the described statistic of type long. | |
| virtual int64 | getLong (int32 id)=0 |
Returns the value of the identified statistic of type long. | |
| virtual int64 | getNumericId ()=0 |
| Gets the number associated with this instance that helps identify it. | |
| virtual int64 | getRawBits (StatisticDescriptor *descriptor)=0 |
| Returns the value of the identified statistic. | |
| virtual const char * | getTextId ()=0 |
| Gets the text associated with this instance that helps identify it. | |
| virtual StatisticsType * | getType ()=0 |
| Gets the StatisticsType of this instance. | |
| virtual int64 | getUniqueId ()=0 |
| Gets a value that uniquely identifies this statistics. | |
| virtual double | incDouble (char *name, double delta)=0 |
Increments the value of the statistic of type double with the given name by a given amount. | |
| virtual double | incDouble (StatisticDescriptor *descriptor, double delta)=0 |
Increments the value of the described statistic of type double by the given amount. | |
| virtual double | incDouble (int32 id, double delta)=0 |
Increments the value of the identified statistic of type double by the given amount. | |
| virtual int32 | incInt (char *name, int32 delta)=0 |
Increments the value of the statistic of type int with the given name by a given amount. | |
| virtual int32 | incInt (StatisticDescriptor *descriptor, int32 delta)=0 |
Increments the value of the described statistic of type int by the given amount. | |
| virtual int32 | incInt (int32 id, int32 delta)=0 |
| Returns the bits that represent the raw value of the named statistic. | |
| virtual int64 | incLong (char *name, int64 delta)=0 |
Increments the value of the statistic of type long with the given name by a given amount. | |
| virtual int64 | incLong (StatisticDescriptor *descriptor, int64 delta)=0 |
Increments the value of the described statistic of type long by the given amount. | |
| virtual int64 | incLong (int32 id, int64 delta)=0 |
Increments the value of the identified statistic of type long by the given amount. | |
| virtual bool | isAtomic ()=0 |
| Returns true if modifications are atomic. | |
| virtual bool | isClosed ()=0 |
| Returns true if the instance has been closed. | |
| virtual bool | isShared ()=0 |
| Returns true if the data for this instance is stored in shared memory. | |
| virtual StatisticDescriptor * | nameToDescriptor (const char *name)=0 |
| Returns the descriptor of the statistic with the given name in this statistics instance. | |
| virtual int32 | nameToId (const char *name)=0 |
| Returns the id of the statistic with the given name in this statistics instance. | |
| virtual void | setDouble (char *name, double value)=0 |
Sets the value of a named statistic of type double. | |
| virtual void | setDouble (StatisticDescriptor *descriptor, double value)=0 |
Sets the value of a described statistic of type double. | |
| virtual void | setDouble (int32 id, double value)=0 |
Sets the value of a statistic with the given id whose type is double. | |
| virtual void | setInt (StatisticDescriptor *descriptor, int32 value)=0 |
Sets the value of a described statistic of type int. | |
| virtual void | setInt (char *name, int32 value)=0 |
Sets the value of a named statistic of type int. | |
| virtual void | setInt (int32 id, int32 value)=0 |
Sets the value of a statistic with the given id whose type is int. | |
| virtual void | setLong (char *name, int64 value)=0 |
Sets the value of a named statistic of type long. | |
| virtual void | setLong (StatisticDescriptor *descriptor, int64 value)=0 |
Sets the value of a described statistic of type long. | |
| virtual void | setLong (int32 id, int64 value)=0 |
Sets the value of a statistic with the given id whose type is long. | |
Protected Member Functions | |
| virtual | ~Statistics ()=0 |
| Destructor is protected to prevent direct deletion. | |
| virtual gemfire_statistics::Statistics::~Statistics | ( | ) | [protected, pure virtual] |
Destructor is protected to prevent direct deletion.
Use close().
| virtual void gemfire_statistics::Statistics::close | ( | ) | [pure 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 gemfire_statistics::Statistics::getDouble | ( | char * | name | ) | [pure virtual] |
Returns the value of the statistic of type double at the given name.
| name | statistic name |
| IllegalArgumentException | If no statistic exists with name name or if the statistic named name is not of type double. |
| virtual double gemfire_statistics::Statistics::getDouble | ( | StatisticDescriptor * | descriptor | ) | [pure virtual] |
Returns the value of the described statistic of type double.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. |
| IllegalArgumentException | If no statistic exists with the specified descriptor or if the described statistic is not of type double. |
| virtual double gemfire_statistics::Statistics::getDouble | ( | int32 | id | ) | [pure virtual] |
Returns the value of the identified statistic of type double.
| id | a statistic id obtained with nameToId or StatisticsType#nameToId. |
| IllegalArgumentException | If the id is invalid. |
| virtual int32 gemfire_statistics::Statistics::getInt | ( | char * | name | ) | [pure virtual] |
Returns the value of the statistic of type int at the given name.
| name | statistic name |
| IllegalArgumentException | If no statistic exists with name name or if the statistic named name is not of type int. |
| virtual int32 gemfire_statistics::Statistics::getInt | ( | StatisticDescriptor * | descriptor | ) | [pure virtual] |
Returns the value of the described statistic of type int.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. |
| IllegalArgumentException | If no statistic exists with the specified descriptor or if the described statistic is not of type int. |
Returns the value of the identified statistic of type int.
| id | a statistic id obtained with nameToId or StatisticsType#nameToId. |
| IllegalArgumentException | If the id is invalid. |
| virtual int64 gemfire_statistics::Statistics::getLong | ( | char * | name | ) | [pure virtual] |
Returns the value of the statistic of type long at the given name.
| name | statistic name |
| IllegalArgumentException | If no statistic exists with name name or if the statistic named name is not of type long. |
| virtual int64 gemfire_statistics::Statistics::getLong | ( | StatisticDescriptor * | descriptor | ) | [pure virtual] |
Returns the value of the described statistic of type long.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. |
| IllegalArgumentException | If no statistic exists with the specified descriptor or if the described statistic is not of type long. |
Returns the value of the identified statistic of type long.
| id | a statistic id obtained with nameToId or StatisticsType#nameToId. |
| IllegalArgumentException | If the id is invalid. |
| virtual int64 gemfire_statistics::Statistics::getNumericId | ( | ) | [pure virtual] |
Gets the number associated with this instance that helps identify it.
| virtual int64 gemfire_statistics::Statistics::getRawBits | ( | StatisticDescriptor * | descriptor | ) | [pure virtual] |
Returns the value of the identified statistic.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. |
| IllegalArgumentException | If the described statistic does not exist Returns the value of the named statistic. | |
| IllegalArgumentException | If the named statistic does not exist Returns the bits that represent the raw value of the described statistic. |
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. |
| IllegalArgumentException | If the described statistic does not exist |
| virtual const char* gemfire_statistics::Statistics::getTextId | ( | ) | [pure virtual] |
Gets the text associated with this instance that helps identify it.
| virtual StatisticsType* gemfire_statistics::Statistics::getType | ( | ) | [pure virtual] |
Gets the StatisticsType of this instance.
| virtual int64 gemfire_statistics::Statistics::getUniqueId | ( | ) | [pure virtual] |
Gets a value that uniquely identifies this statistics.
| virtual double gemfire_statistics::Statistics::incDouble | ( | char * | name, | |
| double | delta | |||
| ) | [pure virtual] |
Increments the value of the statistic of type double with the given name by a given amount.
| name | statistic name | |
| delta | change value to be added |
| IllegalArgumentException | If no statistic exists with name name or if the statistic named name is not of type double. |
| virtual double gemfire_statistics::Statistics::incDouble | ( | StatisticDescriptor * | descriptor, | |
| double | delta | |||
| ) | [pure virtual] |
Increments the value of the described statistic of type double by the given amount.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. | |
| delta | change value to be added |
| IllegalArgumentException | If no statistic exists with the given descriptor or if the described statistic is not of type double. |
| virtual double gemfire_statistics::Statistics::incDouble | ( | int32 | id, | |
| double | delta | |||
| ) | [pure virtual] |
Increments the value of the identified statistic of type double by the given amount.
| id | a statistic id obtained with nameToId or StatisticsType#nameToId. | |
| delta | change value to be added |
| IllegalArgumentException | If the id is invalid. |
Increments the value of the statistic of type int with the given name by a given amount.
| name | statistic name | |
| delta | change value to be added |
| IllegalArgumentException | If no statistic exists with name name or if the statistic named name is not of type int. |
| virtual int32 gemfire_statistics::Statistics::incInt | ( | StatisticDescriptor * | descriptor, | |
| int32 | delta | |||
| ) | [pure virtual] |
Increments the value of the described statistic of type int by the given amount.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. | |
| delta | change value to be added |
| IllegalArgumentException | If no statistic exists with the given descriptor or if the described statistic is not of type int. |
Returns the bits that represent the raw value of the named statistic.
| IllegalArgumentException | If the named statistic does not exist Increments the value of the identified statistic of type int by the given amount. |
| id | a statistic id obtained with nameToId or StatisticsType#nameToId. | |
| delta | change value to be added |
| IllegalArgumentException | If the id is invalid. |
Increments the value of the statistic of type long with the given name by a given amount.
| name | statistic name | |
| delta | change value to be added |
| IllegalArgumentException | If no statistic exists with name name or if the statistic named name is not of type long. |
| virtual int64 gemfire_statistics::Statistics::incLong | ( | StatisticDescriptor * | descriptor, | |
| int64 | delta | |||
| ) | [pure virtual] |
Increments the value of the described statistic of type long by the given amount.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. | |
| delta | change value to be added |
| IllegalArgumentException | If no statistic exists with the given descriptor or if the described statistic is not of type long. |
Increments the value of the identified statistic of type long by the given amount.
| id | a statistic id obtained with nameToId or StatisticsType#nameToId. | |
| delta | change value to be added |
| IllegalArgumentException | If the id is invalid. |
| virtual bool gemfire_statistics::Statistics::isAtomic | ( | ) | [pure virtual] |
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 shared are also atomic.
| virtual bool gemfire_statistics::Statistics::isClosed | ( | ) | [pure virtual] |
Returns true if the instance has been closed.
| virtual bool gemfire_statistics::Statistics::isShared | ( | ) | [pure virtual] |
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 shared are also atomic.
| virtual StatisticDescriptor* gemfire_statistics::Statistics::nameToDescriptor | ( | const char * | name | ) | [pure virtual] |
Returns the descriptor of the statistic with the given name in this statistics instance.
| name | statistic name |
| IllegalArgumentException | No statistic named name exists in this statistics instance. |
| virtual int32 gemfire_statistics::Statistics::nameToId | ( | const char * | name | ) | [pure virtual] |
Returns the id of the statistic with the given name in this statistics instance.
| name | statistic name |
| IllegalArgumentException | No statistic named name exists in this statistics instance. |
| virtual void gemfire_statistics::Statistics::setDouble | ( | char * | name, | |
| double | value | |||
| ) | [pure virtual] |
Sets the value of a named statistic of type double.
| name | statistic name | |
| value | value to set |
| IllegalArgumentException | If no statistic exists named name or if the statistic with name name is not of type double. |
| virtual void gemfire_statistics::Statistics::setDouble | ( | StatisticDescriptor * | descriptor, | |
| double | value | |||
| ) | [pure virtual] |
Sets the value of a described statistic of type double.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. | |
| value | value to set |
| IllegalArgumentException | If no statistic exists for the given descriptor or if the described statistic is not of type double. |
| virtual void gemfire_statistics::Statistics::setDouble | ( | int32 | id, | |
| double | value | |||
| ) | [pure virtual] |
Sets the value of a statistic with the given id whose type is double.
| id | a statistic id obtained with nameToId or StatisticsType#nameToId. | |
| value | value to set |
| IllegalArgumentException | If the id is invalid. |
| virtual void gemfire_statistics::Statistics::setInt | ( | StatisticDescriptor * | descriptor, | |
| int32 | value | |||
| ) | [pure virtual] |
Sets the value of a described statistic of type int.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. | |
| value | value to set |
| IllegalArgumentException | If no statistic exists for the given descriptor or if the described statistic is not of type int. |
| virtual void gemfire_statistics::Statistics::setInt | ( | char * | name, | |
| int32 | value | |||
| ) | [pure virtual] |
Sets the value of a named statistic of type int.
| name | statistic name | |
| value | value to set |
| IllegalArgumentException | If no statistic exists named name or if the statistic with name name is not of type int. |
Sets the value of a statistic with the given id whose type is int.
| id | a statistic id obtained with nameToId or StatisticsType#nameToId. | |
| value | value to set |
| IllegalArgumentException | If the id is invalid. |
| virtual void gemfire_statistics::Statistics::setLong | ( | char * | name, | |
| int64 | value | |||
| ) | [pure virtual] |
Sets the value of a named statistic of type long.
| name | statistic name | |
| value | value to set |
| IllegalArgumentException | If no statistic exists named name or if the statistic with name name is not of type long. |
| virtual void gemfire_statistics::Statistics::setLong | ( | StatisticDescriptor * | descriptor, | |
| int64 | value | |||
| ) | [pure virtual] |
Sets the value of a described statistic of type long.
| descriptor | a statistic descriptor obtained with nameToDescriptor or StatisticsType#nameToDescriptor. | |
| value | value to set |
| IllegalArgumentException | If no statistic exists for the given descriptor or if the described statistic is not of type long. |
Sets the value of a statistic with the given id whose type is long.
| id | a statistic id obtained with nameToId or StatisticsType#nameToId. | |
| value | value to set |
| IllegalArgumentException | If the id is invalid. |