[#BloombergLP-balm-Publisher]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/balm.adoc[balm]::Publisher
:relfileprefix: ../../
:mrdocs:

This protocol class provides a `publish` method to publish collected sample of recorded metric values. The precise meaning of publish is left to derived classes to specify.

== Synopsis

Declared in `<balm_publisher.h>`

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

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/Publisher/2destructor.adoc[`~Publisher`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy this object.
| xref:BloombergLP/balm/Publisher/publish.adoc[`publish`]  [.small]#[virtual]#
| Publish the specified `metricValue`. The exact definition of publish depends on the implementing class, though the intention is that the recorded metric values will be distributed in a human or machine readable form.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/StreamPublisher.adoc[`StreamPublisher`] 
| This class provides an implementation of the `Publisher` protocol. This stream publisher publishes recorded metric values to an output stream specified at construction.
|===


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