ROSE  0.9.10.54
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Sawyer::Message::ImportanceFilter Class Reference

Description

Filters messages based on importance level.

For instance, to disable all messages except fatal and error messages:

Definition at line 878 of file Message.h.

#include <Message.h>

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

Public Member Functions

ImportanceFilterPtr enable (Importance)
 Enable an importance level. More...
 
ImportanceFilterPtr disable (Importance)
 Disable an importance level. More...
 
virtual bool shouldForward (const MesgProps &)
 Predicate determines when a message should be forwarded onward. More...
 
virtual void forwarded (const MesgProps &)
 Called once by bakeDestinations if shouldForward() returned true. More...
 
bool enabled (Importance imp) const
 Property: the enabled/disabled state for a message importance level. More...
 
ImportanceFilterPtr enabled (Importance imp, bool b)
 Property: the enabled/disabled state for a message importance level. More...
 
- Public Member Functions inherited from Sawyer::Message::Filter
virtual void bakeDestinations (const MesgProps &, BakedDestinations &)
 Bakes message properties according to the plumbing lattice. 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 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...
 

Static Public Member Functions

static ImportanceFilterPtr instance (bool dflt)
 Allocating constructor. More...
 
- Static Public Member Functions inherited from Sawyer::Message::Multiplexer
static MultiplexerPtr instance ()
 Allocating constructor. More...
 

Protected Member Functions

 ImportanceFilter (bool dflt)
 Constructor for derived classes. More...
 
- Protected Member Functions inherited from Sawyer::Message::Filter
 Filter ()
 Constructor for derived classes. More...
 
- Protected Member Functions inherited from Sawyer::Message::Multiplexer
 Multiplexer ()
 Constructor for derived classes. More...
 

Additional Inherited Members

- 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

Sawyer::Message::ImportanceFilter::ImportanceFilter ( bool  dflt)
inlineexplicitprotected

Constructor for derived classes.

Non-subclass users should use instance instead.

Definition at line 884 of file Message.h.

Member Function Documentation

static ImportanceFilterPtr Sawyer::Message::ImportanceFilter::instance ( bool  dflt)
inlinestatic

Allocating constructor.

Creates an instance that either allows or disallows all importance levels depending on whether dflt is true or false, respectively.

Definition at line 892 of file Message.h.

bool Sawyer::Message::ImportanceFilter::enabled ( Importance  imp) const

Property: the enabled/disabled state for a message importance level.

Importance levels that are enabled are forwarded to children in the lattice, and those that are disable are discarded.

Thread safety: This method is thread-safe.

ImportanceFilterPtr Sawyer::Message::ImportanceFilter::enabled ( Importance  imp,
bool  b 
)

Property: the enabled/disabled state for a message importance level.

Importance levels that are enabled are forwarded to children in the lattice, and those that are disable are discarded.

Thread safety: This method is thread-safe.

ImportanceFilterPtr Sawyer::Message::ImportanceFilter::enable ( Importance  )

Enable an importance level.

Returns this node so that the method can be chained.

ImportanceFilterPtr Sawyer::Message::ImportanceFilter::disable ( Importance  )

Disable an importance level.

Returns this node so that the method can be chained.

virtual bool Sawyer::Message::ImportanceFilter::shouldForward ( const MesgProps )
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.

Implements Sawyer::Message::Filter.

virtual void Sawyer::Message::ImportanceFilter::forwarded ( const MesgProps )
inlinevirtual

Called once by bakeDestinations if shouldForward() returned true.

This method is called after the properties have been forwarded to the child nodes.

Implements Sawyer::Message::Filter.

Definition at line 918 of file Message.h.


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