balm::Metrics_Helper Struct Reference

#include <balm_metrics.h>

List of all members.

Public Types
enum	NameType { e_TYPE_CATEGORY = 0, e_TYPE_METRIC = 1, TYPE_CATEGORY = e_TYPE_CATEGORY, TYPE_METRIC = e_TYPE_METRIC }
Static Public Member Functions
static void	initializeCategoryHolder (CategoryHolder *holder, const char *category)
static Collector *	getCollector (const char *category, const char *metric)
static IntegerCollector *	getIntegerCollector (const char *category, const char *metric)
static void	setPublicationType (const MetricId &id, PublicationType::Value type)
static void	logEmptyName (const char *name, NameType type, const char *file, int line)

---

Detailed Description

This struct provides a namespace for a suite of functions used in the implementation of the macros defined in this component.

This type is an implementation detail and must not be used (directly) by clients outside of this component.

See Component balm_metrics

---

Member Enumeration Documentation

enum balm::Metrics_Helper::NameType

Enumeration indicating the type of identifier supplied to logEmptyName.

Enumerator:

e_TYPE_CATEGORY
e_TYPE_METRIC
TYPE_CATEGORY
TYPE_METRIC

---

Member Function Documentation

static void balm::Metrics_Helper::initializeCategoryHolder	(	CategoryHolder *	holder,
		const char *	category
	)			[static]

Load into the specified holder the address and enabled status of the specified category, and add holder to the list of category holders for category. The behavior is undefined unless the balm metrics manager singleton is valid.

static Collector* balm::Metrics_Helper::getCollector	(	const char *	category,
		const char *	metric
	)			[static]

Return the address of the default metrics collector for the metric identified by the specified category and metric names. The behavior is undefined unless the balm metrics manager singleton is valid.

static IntegerCollector* balm::Metrics_Helper::getIntegerCollector	(	const char *	category,
		const char *	metric
	)			[static]

Return the address of the default integer metrics collector for the metric identified by the specified category and metric names. The behavior is undefined unless the balm metrics manager singleton is valid.

static void balm::Metrics_Helper::setPublicationType	(	const MetricId &	id,
		PublicationType::Value	type
	)			[static]

Set the publication type for the metric identified by the specified id to the specified type. The behavior is undefined unless the balm metrics manager singleton is valid, and id is a valid identifier supplied by the singleton metrics manager.

static void balm::Metrics_Helper::logEmptyName	(	const char *	name,
		NameType	type,
		const char *	file,
		int	line
	)			[static]

If the specified name is empty or contains only whitespace, then log a warning message indicating whether name is a category or a metric, depending on the specified type, and the location at which this function is called, indicated by the specified file and line; otherwise, do nothing.

---

The documentation for this struct was generated from the following file:

• balm_metrics.h