Description
Converts text to messages.
A message stream is a subclass of std::ostream and therefore allows all the usual stream insertion operators (<<). A stream converts each line of output text to a single message, creating the message with properties defined for the stream and sending the results to a specified destination. Streams typically impart a facility name and importance level to each message via the stream's properties.
#include <Sawyer/Message.h>
Public Member Functions | |
| Stream (const std::string facilityName, Importance imp, const DestinationPtr &destination) | |
| Construct a stream and initialize its name and importance properties. | |
| Stream (const MesgProps &props, const DestinationPtr &destination) | |
| Construct a stream and initialize its properties as specified. | |
| Stream (const Stream &other) | |
| Construct a new stream from an existing stream. | |
| Stream & | operator= (const Stream &other) |
| Initialize this stream from another stream. | |
| Stream (const std::ostream &other_) | |
| Copy constructor with dynamic cast. | |
| Stream & | operator= (const std::ostream &other_) |
| Assignment with dynamic cast. | |
| void | incrementRefCount () |
| size_t | decrementRefCount () |
| SProxy | dup () const |
| Used for partial messages when std::move is missing. | |
| bool | enabled () const |
| Returns true if a stream is enabled. | |
| bool | operator! () const |
| Returns false if this stream is enabled. | |
| MesgProps | properties () const |
| Return the default properties for this stream. | |
| operator void * () const | |
| Returns true if this stream is enabled. | |
| operator bool () const | |
| Returns true if this stream is enabled. | |
| void | enable (bool b=true) |
| Enable or disable a stream. | |
| void | disable () |
| Enable or disable a stream. | |
| void | completionString (const std::string &s, bool asDefault=true) |
| Set message or stream property. | |
| void | interruptionString (const std::string &s, bool asDefault=true) |
| Set message or stream property. | |
| void | cancelationString (const std::string &s, bool asDefault=true) |
| Set message or stream property. | |
| void | facilityName (const std::string &s, bool asDefault=true) |
| Set message or stream property. | |
| DestinationPtr | destination () const |
| Property: message destination. | |
| Stream & | destination (const DestinationPtr &d) |
| Property: message destination. | |
Protected Member Functions | |
| void | initFromNS (const Stream &other) |
Initiaize this stream from other. | |
Constructor & Destructor Documentation
◆ Stream() [1/2]
| Sawyer::Message::Stream::Stream | ( | const Stream & | other | ) |
Construct a new stream from an existing stream.
If other has a pending message then ownership of that message is moved to this new stream.
Thread safety: This method is thread-safe.
◆ Stream() [2/2]
| Sawyer::Message::Stream::Stream | ( | const std::ostream & | other_ | ) |
Copy constructor with dynamic cast.
Same as Stream(const Stream&) but declared so we can do things like this:
Thread safety: This method is thread-safe.
Member Function Documentation
◆ operator=() [1/2]
Initialize this stream from another stream.
If other has a pending message then ownership of that message is moved to this stream.
Thread safety: This method is thread-safe.
◆ operator=() [2/2]
| Stream & Sawyer::Message::Stream::operator= | ( | const std::ostream & | other_ | ) |
Assignment with dynamic cast.
Same as operator=(const Stream&) but declared so we can do things like this:
Thread safety: This method is thread-safe.
◆ dup()
| SProxy Sawyer::Message::Stream::dup | ( | ) | const |
Used for partial messages when std::move is missing.
Thread safety: This method is thread-safe.
◆ initFromNS()
|
protected |
Initiaize this stream from other.
This stream will get its own StreamBuf (if it doesn't have one already), and any pending message from other will be moved (not copied) to this stream.
Thread safety: This method is not thread-safe–the caller is expected to obtain the necessary locks.
◆ enabled()
| bool Sawyer::Message::Stream::enabled | ( | ) | const |
Returns true if a stream is enabled.
Thread safety: This method is thread-safe.
◆ operator void *()
|
inline |
Returns true if this stream is enabled.
This implicit conversion to bool can be used to conveniently avoid expensive insertion operations when a stream is disabled. For example, if printing MemoryMap is an expensive operation then the logging can be written any of these ways to avoid formatting memorymap when logging is disabled:
The SAWYER_MESG_FIRST macro is similar in that it short circuits, but it prints to the first stream that's enabled For example, these two are equivalent:
Thread safety: This method is thread-safe.
◆ operator bool()
|
inline |
Returns true if this stream is enabled.
This implicit conversion to bool can be used to conveniently avoid expensive insertion operations when a stream is disabled. For example, if printing MemoryMap is an expensive operation then the logging can be written any of these ways to avoid formatting memorymap when logging is disabled:
The SAWYER_MESG_FIRST macro is similar in that it short circuits, but it prints to the first stream that's enabled For example, these two are equivalent:
Thread safety: This method is thread-safe.
◆ operator!()
|
inline |
◆ enable()
| void Sawyer::Message::Stream::enable | ( | bool | b = true | ) |
Enable or disable a stream.
A disabled stream buffers the latest partial message and enabling the stream will cause the entire accumulated message to be emitted–whether the partial message immediately appears on the output is up to the message sinks.
Thread safety: This method is thread-safe.
◆ disable()
|
inline |
Enable or disable a stream.
A disabled stream buffers the latest partial message and enabling the stream will cause the entire accumulated message to be emitted–whether the partial message immediately appears on the output is up to the message sinks.
Thread safety: This method is thread-safe.
◆ completionString()
| void Sawyer::Message::Stream::completionString | ( | const std::string & | s, |
| bool | asDefault = true |
||
| ) |
Set message or stream property.
If asDefault is false then the property is set only in the current message and the message must be empty (e.g., just after the previous message was completed). When asDefault is true the new value becomes the default for all future messages. The default also affects the current message if the current message is empty.
Thread safety: This method is thread-safe.
◆ interruptionString()
| void Sawyer::Message::Stream::interruptionString | ( | const std::string & | s, |
| bool | asDefault = true |
||
| ) |
Set message or stream property.
If asDefault is false then the property is set only in the current message and the message must be empty (e.g., just after the previous message was completed). When asDefault is true the new value becomes the default for all future messages. The default also affects the current message if the current message is empty.
Thread safety: This method is thread-safe.
◆ cancelationString()
| void Sawyer::Message::Stream::cancelationString | ( | const std::string & | s, |
| bool | asDefault = true |
||
| ) |
Set message or stream property.
If asDefault is false then the property is set only in the current message and the message must be empty (e.g., just after the previous message was completed). When asDefault is true the new value becomes the default for all future messages. The default also affects the current message if the current message is empty.
Thread safety: This method is thread-safe.
◆ facilityName()
| void Sawyer::Message::Stream::facilityName | ( | const std::string & | s, |
| bool | asDefault = true |
||
| ) |
Set message or stream property.
If asDefault is false then the property is set only in the current message and the message must be empty (e.g., just after the previous message was completed). When asDefault is true the new value becomes the default for all future messages. The default also affects the current message if the current message is empty.
Thread safety: This method is thread-safe.
◆ destination() [1/2]
| DestinationPtr Sawyer::Message::Stream::destination | ( | ) | const |
Property: message destination.
This is the pointer to the top of the plumbing lattice.
Thread safety: This method is thread-safe.
◆ destination() [2/2]
| Stream & Sawyer::Message::Stream::destination | ( | const DestinationPtr & | d | ) |
Property: message destination.
This is the pointer to the top of the plumbing lattice.
Thread safety: This method is thread-safe.
◆ properties()
| MesgProps Sawyer::Message::Stream::properties | ( | ) | const |
Return the default properties for this stream.
These are the properties of the stream itself before they are adjusted by the destination lattice. The default properties are used each time the stream creates a message.
Thread safety: This method is thread-safe.
The documentation for this class was generated from the following file:
