#include <ScribeRouting.h>

Inheritance diagram for m2etis::pubsub::routing::ScribeRouting< NetworkType >:

Public Types
typedef message::ScribeRoutingInfo< NetworkType >	RoutingInfoType

typedef std::vector< typename NetworkType::Key >	KeyList

typedef std::pair< uint64_t, typename NetworkType::Key >	TimePair

typedef std::vector< TimePair >	TimeList

Public Member Functions
	ScribeRouting (const uint16_t topic_name, PubSubSystemEnvironment *pssi, const typename NetworkType::Key &root)

virtual	~ScribeRouting ()

void	setSelf (const typename NetworkType::Key &self)

void	setUnsubscriptionListener (const boost::function< void(const typename NetworkType::Key)> &listener)

void	selfSubscribed (const bool b)

bool	selfSubscribed () const

void	configureRoutingInfo (message::ActionType &msgType, typename message::RoutingInfo< NetworkType >::Ptr routingInfo, typename NetworkType::Key &receiver)

KeyList	getTargetNodes (const message::ActionType mtype, typename message::RoutingInfo< NetworkType >::Ptr routingInfo, typename NetworkType::Key &receiver) const

bool	processSubscribePayload (typename message::RoutingInfo< NetworkType >::Ptr routingInfo, const typename NetworkType::Key &sender, typename NetworkType::Key &receiver, message::ActionType &msgType)

void	processUnsubscribePayload (typename message::RoutingInfo< NetworkType >::Ptr routingInfo, const typename NetworkType::Key &sender, typename NetworkType::Key &receiver, message::ActionType &msgType)

void	processPublishPayload (typename message::RoutingInfo< NetworkType >::Ptr routingInfo, const typename NetworkType::Key &sender, typename NetworkType::Key &receiver, message::ActionType &msgType)

void	processNotifyPayload (typename message::RoutingInfo< NetworkType >::Ptr routingInfo, const typename NetworkType::Key &sender, typename NetworkType::Key &receiver, message::ActionType &msgType)

void	processControlPayload (typename message::RoutingInfo< NetworkType >::Ptr routingInfo, const typename NetworkType::Key &sender, typename NetworkType::Key &receiver, message::ActionType &msgType)

Public Member Functions inherited from m2etis::pubsub::routing::BaseRouting< NetworkType >
	BaseRouting (unsigned int, PubSubSystemEnvironment *)

virtual	~BaseRouting ()

void	configureSendCallback (const boost::function< void(typename message::RoutingInfo< NetworkType >::Ptr, const typename NetworkType::Key &, ControlTarget)> &func)
	with this function, new messages can be sent directly to nodes More...

Public Attributes
const uint64_t	periodic_

const uint64_t	purge_distance_

PubSubSystemEnvironment *	_pssi

boost::function< void(const typename NetworkType::Key)>	removed_subscriber_eventlistener_

uint64_t	purgeID_

Static Public Attributes
static const bool	register_forward_subscribe

static const bool	register_deliver_subscribe

static const bool	register_forward_unsubscribe

static const bool	register_deliver_unsubscribe

static const bool	periodicSubscribtion

Additional Inherited Members
Protected Attributes inherited from m2etis::pubsub::routing::BaseRouting< NetworkType >
boost::function< void(typename message::RoutingInfo< NetworkType >::Ptr, typename NetworkType::Key, ControlTarget)>	sendCtrlMsg_

Detailed Description

template<class NetworkType>
class m2etis::pubsub::routing::ScribeRouting< NetworkType >

Definition at line 41 of file ScribeRouting.h.

Member Typedef Documentation

template<class NetworkType >

typedef std::vector<typename NetworkType::Key> m2etis::pubsub::routing::ScribeRouting< NetworkType >::KeyList

Definition at line 44 of file ScribeRouting.h.

template<class NetworkType >

typedef message::ScribeRoutingInfo<NetworkType> m2etis::pubsub::routing::ScribeRouting< NetworkType >::RoutingInfoType

Definition at line 43 of file ScribeRouting.h.

template<class NetworkType >

typedef std::vector<TimePair> m2etis::pubsub::routing::ScribeRouting< NetworkType >::TimeList

Definition at line 46 of file ScribeRouting.h.

template<class NetworkType >

typedef std::pair<uint64_t, typename NetworkType::Key> m2etis::pubsub::routing::ScribeRouting< NetworkType >::TimePair

Definition at line 45 of file ScribeRouting.h.

Constructor & Destructor Documentation

template<class NetworkType >

m2etis::pubsub::routing::ScribeRouting< NetworkType >::ScribeRouting	(	const uint16_t	topic_name,
		PubSubSystemEnvironment *	pssi,
		const typename NetworkType::Key &	root
	)

inline

Definition at line 81 of file ScribeRouting.h.

Here is the call graph for this function:

template<class NetworkType >

virtual m2etis::pubsub::routing::ScribeRouting< NetworkType >::~ScribeRouting ( )

inlinevirtual

Definition at line 88 of file ScribeRouting.h.

Here is the call graph for this function:

Member Function Documentation

template<class NetworkType >

void m2etis::pubsub::routing::ScribeRouting< NetworkType >::configureRoutingInfo	(	message::ActionType &	msgType,
		typename message::RoutingInfo< NetworkType >::Ptr	routingInfo,
		typename NetworkType::Key &	receiver
	)

inlinevirtual

Configures the periodic messages. Every node runs a thread that triggers subscribe messages. These messages are used for periodical tasks like heart beat, checking the cluster size etc. This means that the message is not always from type subscribe or does not have the same subscription information. Every strategy chooses how to use the periodic messages and can configure it in this function.

Parameters

mtype	Type of message to configure for
routingInfo	object to be configured with the necessary routing information

Implements m2etis::pubsub::routing::BaseRouting< NetworkType >.

Definition at line 111 of file ScribeRouting.h.

template<class NetworkType >

KeyList m2etis::pubsub::routing::ScribeRouting< NetworkType >::getTargetNodes	(	const message::ActionType	mtype,
		typename message::RoutingInfo< NetworkType >::Ptr	routingInfo,
		typename NetworkType::Key &	receiver
	)		const

inlinevirtual

Returns a list of target nodes for the specified message type and action coomand in regard to the node's position in the logic distribution tree.

Parameters

mtype	the type of the message (SUBSCRIBE, UNSUBSCIBE, CONTROL or PUBLISH)
routingInfo	contains the action command and sometimes possible target nodes

Implements m2etis::pubsub::routing::BaseRouting< NetworkType >.

Definition at line 132 of file ScribeRouting.h.

template<class NetworkType >

void m2etis::pubsub::routing::ScribeRouting< NetworkType >::processControlPayload	(	typename message::RoutingInfo< NetworkType >::Ptr	routingInfo,
		const typename NetworkType::Key &	sender,
		typename NetworkType::Key &	receiver,
		message::ActionType &	msgType
	)

inlinevirtual

Handles a control message. The routing information of this node is updated, a decision about continuing the workflow is made and saved in a routingInfo object together with the necessary information. Control messages are used by routing strategies, that do not build the tree implicitly with subscribe messages, but need more complex control commands.

Parameters

routingInfo	contains routing information provided by the sender, will be updated with routing decisions
sender	the senders's key

Implements m2etis::pubsub::routing::BaseRouting< NetworkType >.

Definition at line 219 of file ScribeRouting.h.

template<class NetworkType >

void m2etis::pubsub::routing::ScribeRouting< NetworkType >::processNotifyPayload	(	typename message::RoutingInfo< NetworkType >::Ptr	routingInfo,
		const typename NetworkType::Key &	sender,
		typename NetworkType::Key &	receiver,
		message::ActionType &	msgType
	)

inlinevirtual

Handles a notify message. Most strategies do not do anything, however such messages could affect the tree structure and every strategy should choose on its own what to do.

Parameters

routingInfo	contains routing information provided by the sender, will be updated
sender	the senders's key

Implements m2etis::pubsub::routing::BaseRouting< NetworkType >.

Definition at line 216 of file ScribeRouting.h.

template<class NetworkType >

void m2etis::pubsub::routing::ScribeRouting< NetworkType >::processPublishPayload	(	typename message::RoutingInfo< NetworkType >::Ptr	routingInfo,
		const typename NetworkType::Key &	sender,
		typename NetworkType::Key &	receiver,
		message::ActionType &	msgType
	)

inlinevirtual

Handle a publish message

Implements m2etis::pubsub::routing::BaseRouting< NetworkType >.

Definition at line 209 of file ScribeRouting.h.

template<class NetworkType >

bool m2etis::pubsub::routing::ScribeRouting< NetworkType >::processSubscribePayload	(	typename message::RoutingInfo< NetworkType >::Ptr	routingInfo,
		const typename NetworkType::Key &	sender,
		typename NetworkType::Key &	receiver,
		message::ActionType &	msgType
	)

inlinevirtual

Handles a subscribe message. The routing information of this node is updated, a decision about continuing the workflow is made and saved in a routingInfo object together with the necessary information.

Parameters

routingInfo	contains routing information provided, will be updated with routing decisions
sender	the senders's key

Implements m2etis::pubsub::routing::BaseRouting< NetworkType >.

Definition at line 168 of file ScribeRouting.h.

Here is the call graph for this function:

template<class NetworkType >

void m2etis::pubsub::routing::ScribeRouting< NetworkType >::processUnsubscribePayload	(	typename message::RoutingInfo< NetworkType >::Ptr	routingInfo,
		const typename NetworkType::Key &	sender,
		typename NetworkType::Key &	receiver,
		message::ActionType &	msgType
	)

inlinevirtual

Handles an unsubscribe message. The routing information of this node is updated, a decision about continuing the workflow is made and saved in a routingInfo object together with the necessary information.

Parameters

routingInfo	contains routing information provided by the sender, will be updated
sender	the senders's key

Implements m2etis::pubsub::routing::BaseRouting< NetworkType >.

Definition at line 195 of file ScribeRouting.h.

template<class NetworkType >

void m2etis::pubsub::routing::ScribeRouting< NetworkType >::selfSubscribed ( const bool b )

inline

Definition at line 102 of file ScribeRouting.h.

template<class NetworkType >

bool m2etis::pubsub::routing::ScribeRouting< NetworkType >::selfSubscribed ( ) const

inline

Definition at line 107 of file ScribeRouting.h.

Here is the caller graph for this function:

template<class NetworkType >

void m2etis::pubsub::routing::ScribeRouting< NetworkType >::setSelf ( const typename NetworkType::Key & self )

inline

Definition at line 93 of file ScribeRouting.h.

template<class NetworkType >

void m2etis::pubsub::routing::ScribeRouting< NetworkType >::setUnsubscriptionListener ( const boost::function< void(const typename NetworkType::Key)> & listener )

inlinevirtual

Implements m2etis::pubsub::routing::BaseRouting< NetworkType >.

Definition at line 97 of file ScribeRouting.h.

Member Data Documentation

template<class NetworkType >

PubSubSystemEnvironment* m2etis::pubsub::routing::ScribeRouting< NetworkType >::_pssi

Definition at line 73 of file ScribeRouting.h.

template<class NetworkType >

const uint64_t m2etis::pubsub::routing::ScribeRouting< NetworkType >::periodic_

Definition at line 68 of file ScribeRouting.h.

template<class NetworkType >

const bool m2etis::pubsub::routing::ScribeRouting< NetworkType >::periodicSubscribtion

static

Definition at line 65 of file ScribeRouting.h.

template<class NetworkType >

const uint64_t m2etis::pubsub::routing::ScribeRouting< NetworkType >::purge_distance_

Definition at line 71 of file ScribeRouting.h.

template<class NetworkType >

uint64_t m2etis::pubsub::routing::ScribeRouting< NetworkType >::purgeID_

Definition at line 79 of file ScribeRouting.h.

template<class NetworkType >

const bool m2etis::pubsub::routing::ScribeRouting< NetworkType >::register_deliver_subscribe

static

Definition at line 55 of file ScribeRouting.h.

template<class NetworkType >

const bool m2etis::pubsub::routing::ScribeRouting< NetworkType >::register_deliver_unsubscribe

static

Definition at line 61 of file ScribeRouting.h.

template<class NetworkType >

const bool m2etis::pubsub::routing::ScribeRouting< NetworkType >::register_forward_subscribe

static

Definition at line 52 of file ScribeRouting.h.

template<class NetworkType >

const bool m2etis::pubsub::routing::ScribeRouting< NetworkType >::register_forward_unsubscribe

static

Definition at line 58 of file ScribeRouting.h.

template<class NetworkType >

boost::function<void(const typename NetworkType::Key)> m2etis::pubsub::routing::ScribeRouting< NetworkType >::removed_subscriber_eventlistener_

Definition at line 77 of file ScribeRouting.h.

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

ScribeRouting.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

template<class NetworkType> class m2etis::pubsub::routing::ScribeRouting< NetworkType >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class NetworkType>
class m2etis::pubsub::routing::ScribeRouting< NetworkType >