RSB  0.7.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
rsb::eventprocessing::PushEventReceivingStrategy Class Reference

This class serves as a base class for event receiving strategy classes that deliver rsb::Event s to rsb::Handler s without triggering by the receiving object. More...

#include <PushEventReceivingStrategy.h>

Inheritance diagram for rsb::eventprocessing::PushEventReceivingStrategy:
Inheritance graph
Collaboration diagram for rsb::eventprocessing::PushEventReceivingStrategy:
Collaboration graph

Public Member Functions

virtual void setHandlerErrorStrategy (const ParticipantConfig::ErrorStrategy &strategy)=0
 Defines the strategy to use for handling dispatching errors to the client handler.
virtual void addHandler (rsb::HandlerPtr handler, const bool &wait)=0
 Adds a new handler that will be notified about new events.
virtual void removeHandler (rsb::HandlerPtr handler, const bool &wait)=0
 Removes a handler that will will then not be notified anymore.
- Public Member Functions inherited from rsb::eventprocessing::EventReceivingStrategy
virtual ~EventReceivingStrategy ()
virtual void addFilter (filter::FilterPtr filter)=0
virtual void removeFilter (filter::FilterPtr filter)=0
virtual void handle (EventPtr event)=0
 Dispatches the event to the listener.
- Public Member Functions inherited from rsb::eventprocessing::Handler
virtual ~Handler ()

Detailed Description

This class serves as a base class for event receiving strategy classes that deliver rsb::Event s to rsb::Handler s without triggering by the receiving object.

To achieve this, a list of handlers is maintained and dispatching of events is done by calling each handler.

Author
jmoringe

Definition at line 49 of file PushEventReceivingStrategy.h.

Member Function Documentation

virtual void rsb::eventprocessing::PushEventReceivingStrategy::addHandler ( rsb::HandlerPtr  handler,
const bool &  wait 
)
pure virtual

Adds a new handler that will be notified about new events.

Parameters
handlerhandler to add
waitif set to true, this method must only return after the handler has been install completely so that the next event will be delivered to it

Implemented in rsb::eventprocessing::ParallelEventReceivingStrategy, and rsb::eventprocessing::DirectEventReceivingStrategy.

virtual void rsb::eventprocessing::PushEventReceivingStrategy::removeHandler ( rsb::HandlerPtr  handler,
const bool &  wait 
)
pure virtual

Removes a handler that will will then not be notified anymore.

Parameters
handlerhandler to remove
waitif set to true, this method must only return after the handler has been removed completely and will not receive any more notifications

Implemented in rsb::eventprocessing::ParallelEventReceivingStrategy, and rsb::eventprocessing::DirectEventReceivingStrategy.

virtual void rsb::eventprocessing::PushEventReceivingStrategy::setHandlerErrorStrategy ( const ParticipantConfig::ErrorStrategy strategy)
pure virtual

Defines the strategy to use for handling dispatching errors to the client handler.

Parameters
strategythe new strategy to use

Implemented in rsb::eventprocessing::ParallelEventReceivingStrategy, and rsb::eventprocessing::DirectEventReceivingStrategy.


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