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

Synopsis

Declared in <balm_metrics.h>

struct Metrics_Helper;

Description

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

Enums

Name

Description

NameType

Identifier type constants for logEmptyName.

Static Member Functions

Name

Description

getCollector

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.

getIntegerCollector

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.

initializeCategoryHolder

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.

logEmptyName

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.

setPublicationType

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.

Created with MrDocs