This protocol class provides a pure abstract interface and contract for clients and suppliers of metrics adapters.

Synopsis

Declared in <bdlm_metricsadapter.h>

class MetricsAdapter;

Type Aliases

Name

Description

Callback

Callback functor invoked to collect metric values.

CallbackHandle

Opaque handle identifying a registered collection callback.

Member Functions

Name

Description

~MetricsAdapter [destructor] [virtual]

Destroy this MetricsAdapter.

registerCollectionCallback [virtual]

Register the specified callback with a monitoring system, using the specified metricDescriptor for the registration. Return the callback handle to be used with removeCollectionCallback. Note the information used for registration is implementation dependant, and may involve values computed from the supplied arguments.

removeCollectionCallback [virtual]

Remove the callback associated with the specified handle. Return 0 on success, or a non‐zero value if handle cannot be found.

Derived Classes

Name

Description

BdlmMetricsAdapter

This class implements a pure abstract interface for clients and suppliers of metrics adapters. The implementation registers callbacks with a provided balm::MetricsManager to enable monitoring of statistics collection objects.

Created with MrDocs