[#BloombergLP-bdlm-MetricsRegistryRegistrationHandle]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlm.adoc[bdlm]::MetricsRegistryRegistrationHandle
:relfileprefix: ../../
:mrdocs:

This class implements a registration handle that provides RAII semantics for metric registration.

== Synopsis

Declared in `<bdlm_metricsregistry.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class MetricsRegistryRegistrationHandle;
----

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bdlm/MetricsRegistryRegistrationHandle/2constructor-03.adoc[`MetricsRegistryRegistrationHandle`]         [.small]#[constructor]#
| Constructors
| xref:BloombergLP/bdlm/MetricsRegistryRegistrationHandle/2destructor.adoc[`~MetricsRegistryRegistrationHandle`] [.small]#[destructor]#
| Unregister the metric collection callback associated with this handle (if `isRegistered` is `true`), and destroy this object.
| xref:BloombergLP/bdlm/MetricsRegistryRegistrationHandle/operator_assign.adoc[`operator=`] 
| Unregister the metric collection callback associated with this handle (if `isRegistered` is `true`). Take an ownership on the metric collection callback registration associated with the specified `original` handle. Afterwards, `original` will no longer manage the registration, and `original.isRegistered()` will be `false`.
| xref:BloombergLP/bdlm/MetricsRegistryRegistrationHandle/isRegistered.adoc[`isRegistered`] 
| Return `true` if this handle has an associated registered metrics collection callback.
| xref:BloombergLP/bdlm/MetricsRegistryRegistrationHandle/swap.adoc[`swap`] 
| Exchange the associated metric collection callback registration with the one controlled by the specified `other` handle.
| xref:BloombergLP/bdlm/MetricsRegistryRegistrationHandle/unregister.adoc[`unregister`] 
| Unregister the metric from the associated registry. Return 0 on success, and a non‐zero value if this handle is not currently associated with a registered metrics collection callback.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/bdlm/MetricsRegistry.adoc[BloombergLP::bdlm::MetricsRegistry]`
| This class implements a mechanism that provides a registry of metrics that is transferable to implementations of the `bdlm::MetricsAdapter` protocol. This class is _usually_ a singleton.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#