ROSE  0.9.9.168
Public Member Functions | Protected Attributes | List of all members
Sawyer::Message::Destination Class Referenceabstract

Description

Base class for all types of message destinations.

This is the base class for all nodes in the plumbing lattice.

Definition at line 607 of file Message.h.

#include <Message.h>

Inheritance diagram for Sawyer::Message::Destination:
Inheritance graph
[legend]
Collaboration diagram for Sawyer::Message::Destination:
Collaboration graph
[legend]

Public Member Functions

virtual void bakeDestinations (const MesgProps &, BakedDestinations &baked)
 Bakes message properties according to the plumbing lattice. More...
 
virtual void post (const Mesg &, const MesgProps &bakedProperties)=0
 Causes a message to be emitted. More...
 
MesgProps mergePropertiesNS (const MesgProps &props)
 Merge properties of this lattice node into the specified properties. More...
 
const MesgPropsdefaultPropertiesNS () const
 Default values for message properties. More...
 
MesgPropsdefaultPropertiesNS ()
 Default values for message properties. More...
 
const MesgPropsoverridePropertiesNS () const
 Overrides message properties. More...
 
MesgPropsoverridePropertiesNS ()
 Overrides message properties. More...
 
- Public Member Functions inherited from Sawyer::SharedObject
 SharedObject ()
 Default constructor. More...
 
 SharedObject (const SharedObject &)
 Copy constructor. More...
 
virtual ~SharedObject ()
 Virtual destructor. More...
 
SharedObjectoperator= (const SharedObject &)
 Assignment. More...
 
- Public Member Functions inherited from Sawyer::SharedFromThis< Destination >
SharedPointer< Destination > sharedFromThis ()
 Create a shared pointer from this. More...
 
SharedPointer< const Destination > sharedFromThis () const
 Create a shared pointer from this. More...
 

Protected Attributes

Sawyer::SynchronizationTraits< Sawyer::SingleThreadedTag >::RecursiveMutex mutex_
 Mutex protecting data members here and in subclasses. More...
 
MesgProps dflts_
 Default properties merged into each incoming message. More...
 
MesgProps overrides_
 Override properties applied to incoming message. More...
 

Member Function Documentation

const MesgProps& Sawyer::Message::Destination::defaultPropertiesNS ( ) const
inline

Default values for message properties.

Any message property that has no value coming from a higher layer in the plumbing lattice will be set to the default value if one is defined.

Thread safety: Not thread safe.

Definition at line 625 of file Message.h.

MesgProps& Sawyer::Message::Destination::defaultPropertiesNS ( )
inline

Default values for message properties.

Any message property that has no value coming from a higher layer in the plumbing lattice will be set to the default value if one is defined.

Thread safety: Not thread safe.

Definition at line 626 of file Message.h.

const MesgProps& Sawyer::Message::Destination::overridePropertiesNS ( ) const
inline

Overrides message properties.

Any overriding property value that is defined will override the value coming from a higher layer in the plumbing lattice.

Thread safety: Not thread safe.

Definition at line 637 of file Message.h.

MesgProps& Sawyer::Message::Destination::overridePropertiesNS ( )
inline

Overrides message properties.

Any overriding property value that is defined will override the value coming from a higher layer in the plumbing lattice.

Thread safety: Not thread safe.

Definition at line 638 of file Message.h.

virtual void Sawyer::Message::Destination::bakeDestinations ( const MesgProps ,
BakedDestinations baked 
)
virtual

Bakes message properties according to the plumbing lattice.

The given message properties are applied to the plumbing lattice rooted at this Destination, adjusted according to the default and override properties at this node of the lattice and all lower nodes. The property values at the bottom nodes of the lattice are appended to the baked argument.

Thread safety: All implementations must be thread-safe.

Reimplemented in Sawyer::Message::Filter, and Sawyer::Message::Multiplexer.

virtual void Sawyer::Message::Destination::post ( const Mesg ,
const MesgProps bakedProperties 
)
pure virtual

Causes a message to be emitted.

The bakedProperties argument is one of the values returned by the bakeDestinations method.

Implemented in Sawyer::Message::SyslogSink, Sawyer::Message::StreamSink, Sawyer::Message::FileSink, Sawyer::Message::FdSink, and Sawyer::Message::Multiplexer.

MesgProps Sawyer::Message::Destination::mergePropertiesNS ( const MesgProps props)

Merge properties of this lattice node into the specified properties.

Any property in props that is not set will be set to this node's default value for the property (if any). Any override property defined for this node will override the value (or lack of value) in props. The merged result is returned.

Thread safety: Not thread safe.

Member Data Documentation

Sawyer::SynchronizationTraits< Sawyer::SingleThreadedTag >::RecursiveMutex Sawyer::Message::Destination::mutex_
mutableprotected

Mutex protecting data members here and in subclasses.

Definition at line 609 of file Message.h.

MesgProps Sawyer::Message::Destination::dflts_
protected

Default properties merged into each incoming message.

Definition at line 610 of file Message.h.

MesgProps Sawyer::Message::Destination::overrides_
protected

Override properties applied to incoming message.

Definition at line 611 of file Message.h.


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