This push-style event receiving strategy uses one or more threads to filter rsb::Event s and dispatch matching events to rsb::Handler s. More...

#include <ParallelEventReceivingStrategy.h>

Inheritance diagram for rsb::eventprocessing::ParallelEventReceivingStrategy:

Collaboration diagram for rsb::eventprocessing::ParallelEventReceivingStrategy:

Public Member Functions
	ParallelEventReceivingStrategy (unsigned int numThreads=5)
virtual	~ParallelEventReceivingStrategy ()
std::string	getClassName () const
void	printContents (std::ostream &stream) const
void	setHandlerErrorStrategy (const ParticipantConfig::ErrorStrategy &strategy)
	Defines the strategy to use for handling dispatching errors to the client handler.
virtual void	addHandler (rsb::HandlerPtr handler, const bool &wait)
	Adds a new handler that will be notified about new events.
virtual void	removeHandler (rsb::HandlerPtr handler, const bool &wait)
	Removes a handler that will will then not be notified anymore.
virtual void	addFilter (filter::FilterPtr filter)
virtual void	removeFilter (filter::FilterPtr filter)
void	handle (EventPtr e)
	Dispatches the event to the listener.

Static Public Member Functions
static EventReceivingStrategy *	create (const rsc::runtime::Properties &props)

Private Member Functions
bool	filter (rsb::HandlerPtr handler, EventPtr event)
void	deliver (rsb::HandlerPtr handler, EventPtr event)
void	handleDispatchError (const std::string &message)

Private Attributes
rsc::logging::LoggerPtr	logger
rsc::threading::OrderedQueueDispatcherPool < EventPtr, rsb::Handler >	pool
boost::shared_mutex	filtersMutex
std::set< filter::FilterPtr >	filters
boost::recursive_mutex	errorStrategyMutex
ParticipantConfig::ErrorStrategy	errorStrategy

Detailed Description

This push-style event receiving strategy uses one or more threads to filter rsb::Event s and dispatch matching events to rsb::Handler s.

Author: swrede

Definition at line 62 of file ParallelEventReceivingStrategy.h.

Constructor & Destructor Documentation

rsb::eventprocessing::ParallelEventReceivingStrategy::ParallelEventReceivingStrategy ( unsigned int numThreads = 5 )

Definition at line 52 of file ParallelEventReceivingStrategy.cpp.

References pool.

rsb::eventprocessing::ParallelEventReceivingStrategy::~ParallelEventReceivingStrategy ( )

virtual

Definition at line 61 of file ParallelEventReceivingStrategy.cpp.

References pool.

Member Function Documentation

void rsb::eventprocessing::ParallelEventReceivingStrategy::addFilter ( filter::FilterPtr filter )

virtual

Implements rsb::eventprocessing::EventReceivingStrategy.

Definition at line 202 of file ParallelEventReceivingStrategy.cpp.

References filters, and filtersMutex.

void rsb::eventprocessing::ParallelEventReceivingStrategy::addHandler	(	rsb::HandlerPtr	handler,
		const bool &	wait
	)

virtual

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

Parameters

handler	handler to add
wait	if 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

Implements rsb::eventprocessing::PushEventReceivingStrategy.

Definition at line 190 of file ParallelEventReceivingStrategy.cpp.

References pool.

EventReceivingStrategy * rsb::eventprocessing::ParallelEventReceivingStrategy::create ( const rsc::runtime::Properties & props )

static

Definition at line 48 of file ParallelEventReceivingStrategy.cpp.

Referenced by rsb::eventprocessing::registerDefaultEventProcessingStrategies().

Here is the caller graph for this function:

void rsb::eventprocessing::ParallelEventReceivingStrategy::deliver	(	rsb::HandlerPtr	handler,
		EventPtr	event
	)

private

Definition at line 153 of file ParallelEventReceivingStrategy.cpp.

References handleDispatchError(), and logger.

Here is the call graph for this function:

bool rsb::eventprocessing::ParallelEventReceivingStrategy::filter	(	rsb::HandlerPtr	handler,
		EventPtr	event
	)

private

Definition at line 81 of file ParallelEventReceivingStrategy.cpp.

References filters, filtersMutex, handleDispatchError(), and logger.

Here is the call graph for this function:

string rsb::eventprocessing::ParallelEventReceivingStrategy::getClassName ( ) const

Definition at line 65 of file ParallelEventReceivingStrategy.cpp.

void rsb::eventprocessing::ParallelEventReceivingStrategy::handle ( EventPtr event )

virtual

Dispatches the event to the listener.

Parameters

event the event to dispatch

Implements rsb::eventprocessing::EventReceivingStrategy.

Definition at line 185 of file ParallelEventReceivingStrategy.cpp.

References pool.

void rsb::eventprocessing::ParallelEventReceivingStrategy::handleDispatchError ( const std::string & message )

private

Definition at line 128 of file ParallelEventReceivingStrategy.cpp.

References errorStrategy, errorStrategyMutex, rsb::ParticipantConfig::EXIT, rsb::ParticipantConfig::LOG, logger, and rsb::ParticipantConfig::PRINT.

Referenced by deliver(), and filter().

Here is the caller graph for this function:

void rsb::eventprocessing::ParallelEventReceivingStrategy::printContents ( std::ostream & stream ) const

Definition at line 69 of file ParallelEventReceivingStrategy.cpp.

References errorStrategy, errorStrategyMutex, filters, and filtersMutex.

void rsb::eventprocessing::ParallelEventReceivingStrategy::removeFilter ( filter::FilterPtr filter )

virtual

Implements rsb::eventprocessing::EventReceivingStrategy.

Definition at line 207 of file ParallelEventReceivingStrategy.cpp.

References filters, and filtersMutex.

void rsb::eventprocessing::ParallelEventReceivingStrategy::removeHandler	(	rsb::HandlerPtr	handler,
		const bool &	wait
	)

virtual

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

Parameters

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

Implements rsb::eventprocessing::PushEventReceivingStrategy.

Definition at line 196 of file ParallelEventReceivingStrategy.cpp.

References pool.

void rsb::eventprocessing::ParallelEventReceivingStrategy::setHandlerErrorStrategy ( const ParticipantConfig::ErrorStrategy & strategy )

virtual

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

Parameters

strategy the new strategy to use

Implements rsb::eventprocessing::PushEventReceivingStrategy.

Definition at line 75 of file ParallelEventReceivingStrategy.cpp.

References errorStrategy, and errorStrategyMutex.

Member Data Documentation

ParticipantConfig::ErrorStrategy rsb::eventprocessing::ParallelEventReceivingStrategy::errorStrategy

private

Definition at line 100 of file ParallelEventReceivingStrategy.h.

Referenced by handleDispatchError(), printContents(), and setHandlerErrorStrategy().

boost::recursive_mutex rsb::eventprocessing::ParallelEventReceivingStrategy::errorStrategyMutex

mutableprivate

Definition at line 99 of file ParallelEventReceivingStrategy.h.

Referenced by handleDispatchError(), printContents(), and setHandlerErrorStrategy().

std::set<filter::FilterPtr> rsb::eventprocessing::ParallelEventReceivingStrategy::filters

private

Definition at line 97 of file ParallelEventReceivingStrategy.h.

Referenced by addFilter(), filter(), printContents(), and removeFilter().

boost::shared_mutex rsb::eventprocessing::ParallelEventReceivingStrategy::filtersMutex

mutableprivate

Definition at line 96 of file ParallelEventReceivingStrategy.h.

Referenced by addFilter(), filter(), printContents(), and removeFilter().

rsc::logging::LoggerPtr rsb::eventprocessing::ParallelEventReceivingStrategy::logger

private

Definition at line 93 of file ParallelEventReceivingStrategy.h.

Referenced by deliver(), filter(), and handleDispatchError().

rsc::threading::OrderedQueueDispatcherPool<EventPtr, rsb::Handler> rsb::eventprocessing::ParallelEventReceivingStrategy::pool

private

Definition at line 94 of file ParallelEventReceivingStrategy.h.

Referenced by addHandler(), handle(), ParallelEventReceivingStrategy(), removeHandler(), and ~ParallelEventReceivingStrategy().

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

rsb/eventprocessing/ParallelEventReceivingStrategy.h
rsb/eventprocessing/ParallelEventReceivingStrategy.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation