#include "mama/status.h"
Go to the source code of this file.
Macros | |
#define | MAMA_STAT_NOT_LOCKABLE 0 |
#define | MAMA_STAT_LOCKABLE 1 |
Typedefs | |
typedef enum mamaStatType | mamaStatType |
Functions | |
MAMAExpDLL mama_status | mamaStat_create (mamaStat *stat, mamaStatsCollector collector, int lockable, const char *name, mama_fid_t type) |
Create a mamaStats object. | |
MAMAExpDLL mama_status | mamaStat_destroy (mamaStat stat) |
Destroy a mamaStats object. | |
MAMAExpDLL mama_status | mamaStat_increment (mamaStat stat) |
Increment the stats object counter. | |
MAMAExpDLL mama_status | mamaStat_decrement (mamaStat stat) |
Decrement the stats object counter. | |
MAMAExpDLL mama_status | mamaStat_reset (mamaStat stat) |
Reset the stats object counter. | |
MAMAExpDLL mama_status | mamaStat_add (mamaStat stat, int value) |
Adds the stats object counter with the value. | |
MAMAExpDLL mama_status | mamaStat_subtract (mamaStat stat, int value) |
Subtract the stats object counter with the value. | |
MAMAExpDLL mama_status | mamaStat_setIntervalValue (mamaStat stat, int value) |
set the Interval value | |
MAMAExpDLL mama_fid_t | mamaStat_getFid (mamaStat stat) |
Get the FID used when publishing the stat via the stats logger. | |
MAMAExpDLL int | mamaStat_getIntervalValue (mamaStat stat) |
Get the value of the stat for the current interval. | |
MAMAExpDLL int | mamaStat_getMaxValue (mamaStat stat) |
Get the maximum value of the stat. | |
MAMAExpDLL int | mamaStat_getTotalValue (mamaStat stat) |
Get the total value of the stat. | |
MAMAExpDLL void | mamaStat_getStats (mamaStat stat, mama_i32_t *intervalValue, mama_u32_t *maxValue, mama_u32_t *totalValue) |
Get the interval, maximum, and total values for the stat. | |
MAMAExpDLL const char * | mamaStat_getName (mamaStat stat) |
Get the name of the stat. | |
MAMAExpDLL mama_status | mamaStat_setLog (mamaStat stat, int log) |
Set whether or not this stat should be logged in the MAMA log. | |
MAMAExpDLL int | mamaStat_getLog (mamaStat stat) |
Returns whether or not the stat is currently being logged to the MAMA log. | |
MAMAExpDLL mama_status | mamaStat_setPublish (mamaStat stat, int publish) |
Set whether or not to publish this stat. | |
MAMAExpDLL int | mamaStat_getPublish (mamaStat stat) |
Returns whether or not the stat is currently being published. | |
MAMAExpDLL mamaStatType | mamaStatType_fromString (const char *statTypeString) |
Returns a mamaStatType from a string. | |
MAMAExpDLL const char * | mamaStatType_toString (mamaStatType statType) |
Returns a string representation of a mamaStatType. |
#define MAMA_STAT_NOT_LOCKABLE 0 |
#define MAMA_STAT_LOCKABLE 1 |
typedef enum mamaStatType mamaStatType |
enum mamaStatType |
MAMAExpDLL mama_status mamaStat_create | ( | mamaStat * | stat, |
mamaStatsCollector | collector, | ||
int | lockable, | ||
const char * | name, | ||
mama_fid_t | type | ||
) |
Create a mamaStats object.
stat | The location of a mamaStats to store the result |
MAMAExpDLL mama_status mamaStat_destroy | ( | mamaStat | stat | ) |
Destroy a mamaStats object.
stat | The stats object to destroy |
MAMAExpDLL mama_status mamaStat_increment | ( | mamaStat | stat | ) |
Increment the stats object counter.
stat | The stats object to increment |
MAMAExpDLL mama_status mamaStat_decrement | ( | mamaStat | stat | ) |
Decrement the stats object counter.
stat | The stats object to decrement |
MAMAExpDLL mama_status mamaStat_reset | ( | mamaStat | stat | ) |
Reset the stats object counter.
stat | The stat object to reset |
MAMAExpDLL mama_status mamaStat_add | ( | mamaStat | stat, |
int | value | ||
) |
Adds the stats object counter with the value.
stat | The stats object to added |
value | The value to be added to be stat |
MAMAExpDLL mama_status mamaStat_subtract | ( | mamaStat | stat, |
int | value | ||
) |
Subtract the stats object counter with the value.
stat | The stats object to subtracted |
value | the value to be subtracted from stat |
MAMAExpDLL mama_status mamaStat_setIntervalValue | ( | mamaStat | stat, |
int | value | ||
) |
set the Interval value
stat | The stats object to be changed |
value | the value to be used |
MAMAExpDLL mama_fid_t mamaStat_getFid | ( | mamaStat | stat | ) |
Get the FID used when publishing the stat via the stats logger.
stat | The stat object from which to get the FID |
MAMAExpDLL int mamaStat_getIntervalValue | ( | mamaStat | stat | ) |
Get the value of the stat for the current interval.
stat | The stat object from which to get the invterval value |
MAMAExpDLL int mamaStat_getMaxValue | ( | mamaStat | stat | ) |
Get the maximum value of the stat.
stat | The stat object from which to get the maximum value |
MAMAExpDLL int mamaStat_getTotalValue | ( | mamaStat | stat | ) |
Get the total value of the stat.
stat | The stat object from which to get the total value |
MAMAExpDLL void mamaStat_getStats | ( | mamaStat | stat, |
mama_i32_t * | intervalValue, | ||
mama_u32_t * | maxValue, | ||
mama_u32_t * | totalValue | ||
) |
Get the interval, maximum, and total values for the stat.
stat | The stat object from which to get the values |
intervalValue | Address to which the interval value will be written |
maxValue | Address to which the maximum value will be written |
totalValue | Address to which the total value will be written |
MAMAExpDLL const char* mamaStat_getName | ( | mamaStat | stat | ) |
Get the name of the stat.
The | stat object from which to get the name |
MAMAExpDLL mama_status mamaStat_setLog | ( | mamaStat | stat, |
int | log | ||
) |
Set whether or not this stat should be logged in the MAMA log.
stat | The stat object to set logging for |
log | Whether or not to log the stat |
MAMAExpDLL int mamaStat_getLog | ( | mamaStat | stat | ) |
Returns whether or not the stat is currently being logged to the MAMA log.
The | stat object to get logging for |
MAMAExpDLL mama_status mamaStat_setPublish | ( | mamaStat | stat, |
int | publish | ||
) |
Set whether or not to publish this stat.
stat The stat object to set publishing for publish Whether or not to publish the stat
MAMAExpDLL int mamaStat_getPublish | ( | mamaStat | stat | ) |
Returns whether or not the stat is currently being published.
stat | The stat object to check whether or not it is being published |
MAMAExpDLL mamaStatType mamaStatType_fromString | ( | const char * | statTypeString | ) |
Returns a mamaStatType from a string.
statTypeString | The stat type as a string |
MAMAExpDLL const char* mamaStatType_toString | ( | mamaStatType | statType | ) |
Returns a string representation of a mamaStatType.
statType | The statType to return as a string |