rsb::eventprocessing::PullEventReceivingStrategy Class Reference

Instances of this class retrieve Event s from transport::Connector s when explicitly asked by a client (which usually is a Participant ). More...

#include <PullEventReceivingStrategy.h>

Inheritance diagram for rsb::eventprocessing::PullEventReceivingStrategy:

Collaboration diagram for rsb::eventprocessing::PullEventReceivingStrategy:

Classes
class	Impl

Public Member Functions
	PullEventReceivingStrategy (const std::set< transport::InPullConnectorPtr > &connectors)
virtual	~PullEventReceivingStrategy ()
virtual void	addFilter (filter::FilterPtr filter)
virtual void	removeFilter (filter::FilterPtr filter)
EventPtr	raiseEvent (bool block)
	Retrieve an Event from the connectors and return it. More...
Public Member Functions inherited from rsb::eventprocessing::EventReceivingStrategy
virtual	~EventReceivingStrategy ()
Public Member Functions inherited from rsb::eventprocessing::Handler
virtual	~Handler ()

Private Member Functions
std::string	getClassName () const
void	printContents (std::ostream &stream) const
void	handle (EventPtr event)
	Dispatches the event to the listener. More...

Private Attributes
boost::scoped_ptr< Impl >	d

Detailed Description

Instances of this class retrieve Event s from transport::Connector s when explicitly asked by a client (which usually is a Participant ).

The Retrieval works (roughly) as follows:

1. The client calls the raiseEvent method of the PullEventReceivingStrategy instance
2. The instance calls the raiseEvent methods of its connectors
3. If the event has not been discarded during filtering, it is returned from raiseEvent

Author

jmoringe

Definition at line 67 of file PullEventReceivingStrategy.h.

Constructor & Destructor Documentation

rsb::eventprocessing::PullEventReceivingStrategy::PullEventReceivingStrategy

(

const std::set< transport::InPullConnectorPtr > &

connectors

)

Definition at line 53 of file PullEventReceivingStrategy.cpp.

References d.

rsb::eventprocessing::PullEventReceivingStrategy::~PullEventReceivingStrategy ( )

virtual

Definition at line 58 of file PullEventReceivingStrategy.cpp.

Member Function Documentation

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

virtual

Implements rsb::eventprocessing::EventReceivingStrategy.

Definition at line 61 of file PullEventReceivingStrategy.cpp.

References d.

std::string rsb::eventprocessing::PullEventReceivingStrategy::getClassName ( ) const

private

Definition at line 86 of file PullEventReceivingStrategy.cpp.

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

privatevirtual

Dispatches the event to the listener.

Parameters

event

the event to dispatch

Implements rsb::eventprocessing::EventReceivingStrategy.

Definition at line 84 of file PullEventReceivingStrategy.cpp.

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

private

Definition at line 90 of file PullEventReceivingStrategy.cpp.

References d.

EventPtr rsb::eventprocessing::PullEventReceivingStrategy::raiseEvent

(

bool

block

)

Retrieve an Event from the connectors and return it.

Parameters

block

Controls whether the call should block until an event becomes available if that is not the case immediately.

Returns

A pointer to the received event.

Definition at line 69 of file PullEventReceivingStrategy.cpp.

References d.

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

virtual

Implements rsb::eventprocessing::EventReceivingStrategy.

Definition at line 65 of file PullEventReceivingStrategy.cpp.

References d.

Member Data Documentation

boost::scoped_ptr<Impl> rsb::eventprocessing::PullEventReceivingStrategy::d

private

Definition at line 85 of file PullEventReceivingStrategy.h.

Referenced by addFilter(), printContents(), PullEventReceivingStrategy(), raiseEvent(), and removeFilter().

---

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

• rsb/eventprocessing/PullEventReceivingStrategy.h
• rsb/eventprocessing/PullEventReceivingStrategy.cpp