A task that receives FragmentedNotifications from a SpreadConnection, deserializes them to events and notifies a handler with deserialized Events. More...

#include <ReceiverTask.h>

Collaboration diagram for rsb::spread::ReceiverTask:

Public Member Functions
	ReceiverTask (SpreadConnectionPtr s, eventprocessing::HandlerPtr handler, InPushConnector *connector)
virtual	~ReceiverTask ()
void	execute ()
void	setHandler (eventprocessing::HandlerPtr handler)
void	setPruning (const bool &pruning)
	Enables or disables pruning of messages and waits until the changes are performed.

Private Member Functions
void	notifyHandler (protocol::NotificationPtr notification)
	Notifies the handler of this task about a received event which is generated from an internal notification and the joined data that may originate from several fragments of the notification.
rsb::protocol::NotificationPtr	handleAndJoinFragmentedNotification (protocol::FragmentedNotificationPtr notification)
	Handles newly received notifications by extracting their data, joining the data if it is part of a multi-part message and returning the joined notification.

Private Attributes
rsc::logging::LoggerPtr	logger
SpreadConnectionPtr	con
InPushConnector *	connector
AssemblyPoolPtr	assemblyPool
eventprocessing::HandlerPtr	handler
boost::recursive_mutex	handlerMutex

Detailed Description

A task that receives FragmentedNotifications from a SpreadConnection, deserializes them to events and notifies a handler with deserialized Events.

Messages may be split into multiple FragmentedNotifications to respect the spread limitations. Hence, there is an assembly strategy for multiple notifications forming one Event. An optional pruning for Event fragments may be enable to avoid a growing pool if FragmentedNotifications are lost. As a default this pruning is disabled.

Author: swrede; jwienke

Definition at line 74 of file ReceiverTask.h.

Constructor & Destructor Documentation

rsb::spread::ReceiverTask::ReceiverTask	(	SpreadConnectionPtr	s,
		eventprocessing::HandlerPtr	handler,
		InPushConnector *	connector
	)

Definition at line 53 of file ReceiverTask.cpp.

References con, and logger.

rsb::spread::ReceiverTask::~ReceiverTask ( )

virtual

Definition at line 63 of file ReceiverTask.cpp.

Member Function Documentation

void rsb::spread::ReceiverTask::execute ( )

Definition at line 66 of file ReceiverTask.cpp.

References con, handleAndJoinFragmentedNotification(), logger, notifyHandler(), and rsb::spread::SpreadMessage::REGULAR.

Here is the call graph for this function:

NotificationPtr rsb::spread::ReceiverTask::handleAndJoinFragmentedNotification ( protocol::FragmentedNotificationPtr notification )

private

Handles newly received notifications by extracting their data, joining the data if it is part of a multi-part message and returning the joined notification.

Parameters

notification notification to handler

Returns: pointer to the joined notification

Definition at line 119 of file ReceiverTask.cpp.

References assemblyPool.

Referenced by execute().

Here is the caller graph for this function:

void rsb::spread::ReceiverTask::notifyHandler ( protocol::NotificationPtr notification )

private

Notifies the handler of this task about a received event which is generated from an internal notification and the joined data that may originate from several fragments of the notification.

Parameters

notification notification with full data to notify about

Definition at line 138 of file ReceiverTask.cpp.

References connector, rsb::protocol::fillEvent(), rsb::transport::ConverterSelectingConnector< WireType >::getConverter(), handler, handlerMutex, and logger.

Referenced by execute().

Here is the call graph for this function: