bdlm::MetricsAdapter Class Reference

#include <bdlm_metricsadapter.h>

Inheritance diagram for bdlm::MetricsAdapter:

Detailed Description

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

See bdlm_metricsadapter

Public Types
typedef int	CallbackHandle
typedef bsl::function< void(Metric *)>	Callback

Public Member Functions
virtual	~MetricsAdapter ()=0
virtual CallbackHandle	registerCollectionCallback (const MetricDescriptor &metricDescriptor, const Callback &callback)=0
virtual int	removeCollectionCallback (const CallbackHandle &handle)=0

Member Typedef Documentation

Callback

typedef bsl::function<void (Metric *)> bdlm::MetricsAdapter::Callback

CallbackHandle

typedef int bdlm::MetricsAdapter::CallbackHandle

Constructor & Destructor Documentation

~MetricsAdapter()

virtual bdlm::MetricsAdapter::~MetricsAdapter ( )

pure virtual

Destroy this MetricsAdapter.

Member Function Documentation

registerCollectionCallback()

virtual CallbackHandle bdlm::MetricsAdapter::registerCollectionCallback ( const MetricDescriptor &  metricDescriptor, const Callback &  callback  )

pure 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.

Implemented in balm::BdlmMetricsAdapter.

removeCollectionCallback()

virtual int bdlm::MetricsAdapter::removeCollectionCallback ( const CallbackHandle &  handle )

pure virtual

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

Implemented in balm::BdlmMetricsAdapter.

---

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

• bdlm_metricsadapter.h