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

This class provides an implementation of the `Publisher` protocol. This stream publisher publishes recorded metric values to an output stream specified at construction.

== Synopsis

Declared in `<balm_streampublisher.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
class StreamPublisher
    : public xref:BloombergLP/balm/Publisher.adoc[Publisher]
----

== Base Classes

[cols="1,4"]
|===
| Name| Description
| `xref:BloombergLP/balm/Publisher.adoc[Publisher]`
| 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.
|===

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/balm/StreamPublisher/2constructor.adoc[`StreamPublisher`]         [.small]#[constructor]#
| Create a streampublisher and initialize it to publish metrics to the specified `stream`.
| xref:BloombergLP/balm/StreamPublisher/2destructor.adoc[`~StreamPublisher`] [.small]#[destructor]# [.small]#[virtual]#
| Destroy this stream publisher.
| xref:BloombergLP/balm/StreamPublisher/publish-06.adoc[`publish`] 
| `publish` overloads
|===



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