ROSE  0.9.10.89
Public Member Functions | Public Attributes | List of all members
Sawyer::Message::MesgProps Struct Reference

Description

Properties for messages.

Each message property is optional. When a message is sent through the plumbing, each node of the plumbing lattice may provide default values for properties that are not set, or may override properties that are set.

Thread safety: This object uses no global state, but is otherwise not thread-safe except where noted.

Definition at line 424 of file Message.h.

#include <Message.h>

Collaboration diagram for Sawyer::Message::MesgProps:
Collaboration graph
[legend]

Public Member Functions

MesgProps merge (const MesgProps &) const
 Merge the specified properties into this object and return new properties. More...
 
void print (std::ostream &) const
 Print the values for all properties. More...
 

Public Attributes

Optional< std::string > facilityName
 The name of the logging facility that produced this message. More...
 
Optional< Importanceimportance
 The message importance level. More...
 
boost::tribool isBuffered
 Whether the output buffered and emitted on a per-message basis. More...
 
Optional< std::string > completionStr
 String to append to the end of each complete message. More...
 
Optional< std::string > interruptionStr
 String to append when a partial message is interrupted. More...
 
Optional< std::string > cancelationStr
 String to append to a partial message when it is destroyed. More...
 
Optional< std::string > lineTermination
 Line termination for completion, interruption, and cancelation. More...
 
boost::tribool useColor
 Whether to use ANSI escape sequences to colorize output. More...
 

Member Function Documentation

MesgProps Sawyer::Message::MesgProps::merge ( const MesgProps ) const

Merge the specified properties into this object and return new properties.

Each property of the return value will be the value from this object, except when this object's property is missing, in which case the property value from the argument is used (which may also be missing).

void Sawyer::Message::MesgProps::print ( std::ostream &  ) const

Print the values for all properties.

This is used mainly for debugging.

Member Data Documentation

Optional<std::string> Sawyer::Message::MesgProps::facilityName

The name of the logging facility that produced this message.

Definition at line 426 of file Message.h.

Referenced by Sawyer::Message::Mesg::Mesg().

Optional<Importance> Sawyer::Message::MesgProps::importance

The message importance level.

Definition at line 427 of file Message.h.

Referenced by Sawyer::Message::Mesg::Mesg().

boost::tribool Sawyer::Message::MesgProps::isBuffered

Whether the output buffered and emitted on a per-message basis.

Definition at line 428 of file Message.h.

Optional<std::string> Sawyer::Message::MesgProps::completionStr

String to append to the end of each complete message.

Definition at line 429 of file Message.h.

Optional<std::string> Sawyer::Message::MesgProps::interruptionStr

String to append when a partial message is interrupted.

Definition at line 430 of file Message.h.

Optional<std::string> Sawyer::Message::MesgProps::cancelationStr

String to append to a partial message when it is destroyed.

Definition at line 431 of file Message.h.

Optional<std::string> Sawyer::Message::MesgProps::lineTermination

Line termination for completion, interruption, and cancelation.

Definition at line 432 of file Message.h.

boost::tribool Sawyer::Message::MesgProps::useColor

Whether to use ANSI escape sequences to colorize output.

Definition at line 433 of file Message.h.


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