fesa::OnSubscriptionEventSource Class Reference

OnSubscriptionEventSource is dedicated to establish subscriptions using the ProxyInterface and then trigger a rtEvent per notification received. More...

#include <OnSubscriptionEventSource.h>

Inheritance diagram for fesa::OnSubscriptionEventSource:

List of all members.

Classes
struct	EventInfo
	stores information about an event More...
class	SubscriptionThread
	This class creates a thread that keeps the reconnection of pending subscriptions. More...
Public Member Functions
	OnSubscriptionEventSource ()
	constructor
Private Types
typedef std::multimap < std::pair< std::string, std::string >, std::string >	OnSubscriptionEventMapping
typedef std::set< std::pair < std::string, std::string > >	PendingSubscriptions
Private Member Functions
	~OnSubscriptionEventSource ()
	destructor
void	connect (boost::shared_ptr< fesa::EventElement > &eventElement)
	Connect method is used to register a new subscription.
RTEvent *	wait ()
	calling this method the current thread is suspended until a new notification is received.
bool	startSubscriptions ()
	This method is in charge of starting all the subscriptions already registered by the connect method.
void	createSubscriptionThread ()
void	deleteSubscriptionThread ()
Private Attributes
EventInfo	eventInfo_
ProxyInterface	proxy_
OnSubscriptionEventMapping	onSubscriptionEventMapping_
PendingSubscriptions	pendingSubscriptions_
OnSubscriptionEventMapping::iterator	itr1_
	pointer to the first element in the map
OnSubscriptionEventMapping::iterator	itr2_
	pointer to the last element in the map
bool	IsSubscriptionStarted_
	Flag to know if the subscriptions have been already started or not.
SubscriptionThread *	subscriptionThread_
	Pointer to the thread in charge to establish the remaining subscriptions.
Friends
class	AbstractRealTimeLabObjectFactory
class	AbstractEventSourceFactory

Detailed Description

OnSubscriptionEventSource is dedicated to establish subscriptions using the ProxyInterface and then trigger a rtEvent per notification received.

Definition at line 22 of file OnSubscriptionEventSource.h.

Member Typedef Documentation

typedef std::multimap<std::pair<std::string, std::string>, std::string> fesa::OnSubscriptionEventSource::OnSubscriptionEventMapping [private]

multimap<<deviceName, propertyname> fesaEventName>

Definition at line 78 of file OnSubscriptionEventSource.h.

typedef std::set<std::pair<std::string, std::string> > fesa::OnSubscriptionEventSource::PendingSubscriptions [private]

Definition at line 82 of file OnSubscriptionEventSource.h.

Constructor & Destructor Documentation

fesa::OnSubscriptionEventSource::OnSubscriptionEventSource ( )

constructor

Definition at line 26 of file OnSubscriptionEventSource.cpp.

References IsSubscriptionStarted_, itr1_, itr2_, onSubscriptionEventMapping_, and subscriptionThread_.

fesa::OnSubscriptionEventSource::~OnSubscriptionEventSource ( ) [private]

destructor

Definition at line 35 of file OnSubscriptionEventSource.cpp.

References deleteSubscriptionThread(), and subscriptionThread_.

Member Function Documentation

void fesa::OnSubscriptionEventSource::connect ( boost::shared_ptr< fesa::EventElement > & eventElement ) [private, virtual]

Connect method is used to register a new subscription.

Parameters:

eventName

coming from instantiation. The subscription is identified by the set of device name, property name and cycle selector name with the format: "deviceName:propertyName#logicalEventName"

Implements fesa::AbstractEventSource.

Definition at line 41 of file OnSubscriptionEventSource.cpp.

References fesa::ON_SUBSCRIPTION_TAG_DEVICE, fesa::ON_SUBSCRIPTION_TAG_PROPERTY, onSubscriptionEventMapping_, and pendingSubscriptions_.

void fesa::OnSubscriptionEventSource::createSubscriptionThread ( ) [private]

Definition at line 139 of file OnSubscriptionEventSource.cpp.

References fesa::Thread::getPriority(), fesa::Thread::setPriority(), fesa::Thread::start(), and subscriptionThread_.

Referenced by wait().

void fesa::OnSubscriptionEventSource::deleteSubscriptionThread ( ) [private]

Definition at line 146 of file OnSubscriptionEventSource.cpp.

References fesa::Thread::stop(), and subscriptionThread_.

Referenced by fesa::OnSubscriptionEventSource::SubscriptionThread::run(), and ~OnSubscriptionEventSource().

bool fesa::OnSubscriptionEventSource::startSubscriptions ( ) [private]