A single message.
A message consists of a string and can be in a partial, completed, or canceled state. More text can be added to a message while it is in the partial state, but once the message is marked as completed or canceled the text becomes immutable. Messages also have properties, which are fed into the plumbing lattice and adjusted as they traverse to the final destinations during a process called "baking".
Thread safety: This object uses global state, but is otherwise not thread-safe except where noted.
Definition at line 513 of file Message.h.
|
| Mesg () |
| Creates a new, partial message that is empty.
|
|
| Mesg (const std::string &facilityName, Importance imp) |
| Creates a new, partial message that is empty. More...
|
|
| Mesg (const MesgProps &props) |
| Creates a new, partial message that is empty. More...
|
|
| Mesg (const std::string &mesg) |
| Creates a new, completed message with the specified text.
|
|
| Mesg (const std::string &facilityName, Importance imp, const std::string &mesg) |
| Creates a new, completed message with the specified text. More...
|
|
| Mesg (const MesgProps &props, const std::string &mesg) |
| Creates a new, completed message with the specified text. More...
|
|
unsigned | id () const |
| Return unique message ID. More...
|
|
const std::string & | text () const |
| Return the message text.
|
|
bool | isComplete () const |
| Returns true if the message has entered the completed state. More...
|
|
bool | isCanceled () const |
| Returns true if the message has entered the canceled state. More...
|
|
bool | isEmpty () const |
| Returns true if the message has no text. More...
|
|
bool | hasText () const |
| Returns true if the message has text other than white space. More...
|
|
void | complete () |
| Cause the message to enter the completed state. More...
|
|
void | cancel () |
| Cause the message to enter the canceled state. More...
|
|
void | post (const BakedDestinations &) const |
| Send a message to its final destinations.
|
|
|
const MesgProps & | properties () const |
| Returns a reference to message properties. More...
|
|
MesgProps & | properties () |
| Returns a reference to message properties. More...
|
|
|
void | insert (const std::string &) |
| Append additional text to the end of the message. More...
|
|
void | insert (char) |
| Append additional text to the end of the message. More...
|
|