statscollector.h File Reference

#include "mama/status.h"

Go to the source code of this file.

Typedefs
typedef enum mamaStatsCollectorType	mamaStatsCollectorType

Enumerations
enum	mamaStatsCollectorType { MAMA_STATS_COLLECTOR_TYPE_QUEUE = 0, MAMA_STATS_COLLECTOR_TYPE_TRANSPORT = 1, MAMA_STATS_COLLECTOR_TYPE_USER = 2, MAMA_STATS_COLLECTOR_TYPE_GLOBAL = 3 }

Functions
MAMAExpDLL mama_status	mamaStatsCollector_create (mamaStatsCollector *statsCollector, mamaStatsCollectorType type, const char *name, const char *middleware)
	Create a mamaStatsCollector object. More...
MAMAExpDLL mama_status	mamaStatsCollector_destroy (mamaStatsCollector statsCollector)
	Destroy a mamaStatsCollector object. More...
MAMAExpDLL mama_status	mamaStatsCollector_addStat (mamaStatsCollector statsCollector, mamaStat stat)
	Register a stats object with the collector. More...
MAMAExpDLL mama_status	mamaStatsCollector_incrementStat (mamaStatsCollector statsCollector, mama_fid_t identifier)
	Increment the current interval value of the stat represented by FID identifier. More...
MAMAExpDLL mama_status	mamaStatsCollector_setName (mamaStatsCollector statsCollector, const char *name)
	Set the name of the stats collector object. More...
MAMAExpDLL mama_status	mamaStatsCollector_setPublish (mamaStatsCollector statsCollector, int publish)
	Set whether or not stats for this stats collector object should be published in stats messages. More...
MAMAExpDLL int	mamaStatsCollector_getPublish (mamaStatsCollector statsCollector)
	Get whether or not stats are being published for this stats collector. More...
MAMAExpDLL mama_status	mamaStatsCollector_setLog (mamaStatsCollector statsCollector, int log)
	Set whether or not stats for this stats collector object should be logged to the MAMA log. More...
MAMAExpDLL int	mamaStatsCollector_getLog (mamaStatsCollector statsCollector)
	Get whether or not stats are being logged for this stats collector. More...
const MAMAExpDLL char *	mamaStatsCollectorType_stringForType (mamaStatsCollectorType type)
	Return a string representation of a mamaStatsCollectorType. More...

Typedef Documentation

mamaStatsCollectorType

typedef enum mamaStatsCollectorType mamaStatsCollectorType

Enumeration Type Documentation

mamaStatsCollectorType

enum mamaStatsCollectorType

Enumerator
MAMA_STATS_COLLECTOR_TYPE_QUEUE
MAMA_STATS_COLLECTOR_TYPE_TRANSPORT
MAMA_STATS_COLLECTOR_TYPE_USER
MAMA_STATS_COLLECTOR_TYPE_GLOBAL

{
    MAMA_STATS_COLLECTOR_TYPE_QUEUE     = 0,
    MAMA_STATS_COLLECTOR_TYPE_TRANSPORT = 1,
    MAMA_STATS_COLLECTOR_TYPE_USER      = 2,
    MAMA_STATS_COLLECTOR_TYPE_GLOBAL    = 3
} mamaStatsCollectorType;

Function Documentation

mamaStatsCollector_create()

MAMAExpDLL mama_status mamaStatsCollector_create	(	mamaStatsCollector *	statsCollector,
		mamaStatsCollectorType	type,
		const char *	name,
		const char *	middleware
	)

Create a mamaStatsCollector object.

Parameters

statsCollector

The stats collector object to create

mamaStatsCollector_destroy()

MAMAExpDLL mama_status mamaStatsCollector_destroy

(

mamaStatsCollector

statsCollector

)

Destroy a mamaStatsCollector object.

Parameters

statsCollector

The stats collector object to destroy

mamaStatsCollector_addStat()

MAMAExpDLL mama_status mamaStatsCollector_addStat	(	mamaStatsCollector	statsCollector,
		mamaStat	stat
	)

Register a stats object with the collector.

Parameters

statscollector	The stats collector object to register with
stat	The stat object to register

mamaStatsCollector_incrementStat()

MAMAExpDLL mama_status mamaStatsCollector_incrementStat	(	mamaStatsCollector	statsCollector,
		mama_fid_t	identifier
	)

Increment the current interval value of the stat represented by FID identifier.

Parameters

statscollector	The stats collector object for which to increment the stat
identifier	FID of the stat to increment

mamaStatsCollector_setName()

MAMAExpDLL mama_status mamaStatsCollector_setName	(	mamaStatsCollector	statsCollector,
		const char *	name
	)

Set the name of the stats collector object.

By default, this will be the same as the associated queue, transport, or MAMA Application.

Parameters

statscollector	The stats collector object for which to set the name
name	The name to set for the stats collector

mamaStatsCollector_setPublish()

MAMAExpDLL mama_status mamaStatsCollector_setPublish	(	mamaStatsCollector	statsCollector,
		int	publish
	)

Set whether or not stats for this stats collector object should be published in stats messages.

Parameters

statscollector	The stats collector object to set publishing for
publish	Whether or not to publish stats for this stats collector

mamaStatsCollector_getPublish()

MAMAExpDLL int mamaStatsCollector_getPublish

(

mamaStatsCollector

statsCollector

)

Get whether or not stats are being published for this stats collector.

Parameters

statscollector

The stats collector object to get publishing for

mamaStatsCollector_setLog()

MAMAExpDLL mama_status mamaStatsCollector_setLog	(	mamaStatsCollector	statsCollector,
		int	log
	)

Set whether or not stats for this stats collector object should be logged to the MAMA log.

Parameters

statscollector	The stats collector object to set logging for
log	Whether or not to log stats for this stats collector

mamaStatsCollector_getLog()

MAMAExpDLL int mamaStatsCollector_getLog

(

mamaStatsCollector

statsCollector

)

Get whether or not stats are being logged for this stats collector.

Parameters

statscollector

The stats collector object to get logging for.

mamaStatsCollectorType_stringForType()

const MAMAExpDLL char* mamaStatsCollectorType_stringForType

(

mamaStatsCollectorType

type

)

Return a string representation of a mamaStatsCollectorType.

Parameters

type	The stats collector type to return as a string