Description
Base class for internal nodes that filter messages.
Filtering is applied when properties are baked, which should happen exactly once for each message, usually just before the message is posted for the first time.
#include <util/Sawyer/Message.h>
Public Member Functions | |
| virtual void | bakeDestinations (const MesgProps &, BakedDestinations &) |
| Bakes message properties according to the plumbing lattice. More... | |
| virtual bool | shouldForward (const MesgProps &)=0 |
| Predicate determines when a message should be forwarded onward. More... | |
| virtual void | forwarded (const MesgProps &)=0 |
| Called once by bakeDestinations if shouldForward() returned true. More... | |
 Public Member Functions inherited from Sawyer::Message::Multiplexer | |
| virtual void | post (const Mesg &, const MesgProps &) |
| Causes a message to be emitted. More... | |
| MultiplexerPtr | addDestination (const DestinationPtr &) |
| Adds a child node to this node of the lattice. More... | |
| MultiplexerPtr | removeDestination (const DestinationPtr &) |
| Removes the specified child from this node of the lattice. More... | |
| MultiplexerPtr | to (const DestinationPtr &) |
| Add a child nodes to this node of the lattice and returns this node. More... | |
| MultiplexerPtr | to (const DestinationPtr &, const DestinationPtr &) |
| Add a child nodes to this node of the lattice and returns this node. More... | |
| MultiplexerPtr | to (const DestinationPtr &, const DestinationPtr &, const DestinationPtr &) |
| Add a child nodes to this node of the lattice and returns this node. More... | |
| MultiplexerPtr | to (const DestinationPtr &, const DestinationPtr &, const DestinationPtr &, const DestinationPtr &) |
| Add a child nodes to this node of the lattice and returns this node. More... | |
| Public Member Functions inherited from Sawyer::Message::Destination | |
| MesgProps | mergePropertiesNS (const MesgProps &props) |
| Merge properties of this lattice node into the specified properties. More... | |
| const MesgProps & | defaultPropertiesNS () const |
| Default values for message properties. More... | |
| MesgProps & | defaultPropertiesNS () |
| Default values for message properties. More... | |
| const MesgProps & | overridePropertiesNS () const |
| Overrides message properties. More... | |
| MesgProps & | overridePropertiesNS () |
| 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... | |
| SharedObject & | operator= (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 Member Functions | |
| Filter () | |
| Constructor for derived classes. More... | |
| Protected Member Functions inherited from Sawyer::Message::Multiplexer | |
| Multiplexer () | |
| Constructor for derived classes. More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Sawyer::Message::Multiplexer | |
| static MultiplexerPtr | instance () |
| Allocating constructor. More... | |
| Protected Attributes inherited from Sawyer::Message::Destination | |
| 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... | |
Constructor & Destructor Documentation
|
inlineprotected |
Member Function Documentation
|
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 from Sawyer::Message::Multiplexer.
|
pure virtual |
Predicate determines when a message should be forwarded onward.
This method is called once from bakeDestinations(), and if it returns true then the baking is forwarded on to the child nodes in the plumbing lattice. If this method returns false then none of the descendents will see the properties (unless they can be reached by some other path), and the unreached leaf nodes will not be returned by bakeDestinations().
Thread safety: all implementations must be thread-safe.
Implemented in Sawyer::Message::ImportanceFilter, Sawyer::Message::TimeFilter, and Sawyer::Message::SequenceFilter.
|
pure virtual |
Called once by bakeDestinations if shouldForward() returned true.
This method is called after the properties have been forwarded to the child nodes.
Implemented in Sawyer::Message::ImportanceFilter, Sawyer::Message::TimeFilter, and Sawyer::Message::SequenceFilter.
The documentation for this class was generated from the following file:
