senf::ppi::ForwardingRoute Class Reference

Forwarding route base class. More...

#include <senf/PPI/Route.hh>

Inheritance diagram for senf::ppi::ForwardingRoute:

Public Member Functions
bool	autoThrottling () const
	Query current autoThrottling state. More...
void	autoThrottling (bool state)
	Change automatic throttle notification forwarding. More...
bool	throttled () const
	true, if the route is throttled More...
Public Member Functions inherited from senf::ppi::RouteBase
virtual	~RouteBase ()
bool	hasConnector (connector::Connector const &conn) const
	true, if route has connector conn More...
bool	hasEvent (EventDescriptor const &event) const
	true, if route has event event More...

Protected Member Functions
	ForwardingRoute ()
template<class T >
void	registerRoute (T &ob)
template<class T >
void	unregisterRoute (T &ob)
template<class T >
void	notifyThrottle (T &ob)
template<class T >
void	notifyUnthrottle (T &ob)
Protected Member Functions inherited from senf::ppi::RouteBase
	RouteBase ()
Source &	source () const
	Routing source. More...
Target &	target () const
	Routing target. More...

Detailed Description

Forwarding route base class.

All routes which may forward control information are based on ForwardingRoute. ForwardingRoute provides methods to control and query the throttling behavior.

Definition at line 69 of file Route.hh.

Constructor & Destructor Documentation

ForwardingRoute()

senf::ppi::ForwardingRoute::ForwardingRoute ( )

protected

Member Function Documentation

autoThrottling() [1/2]

bool senf::ppi::ForwardingRoute::autoThrottling

(

)

const

Query current autoThrottling state.

autoThrottling() [2/2]

void senf::ppi::ForwardingRoute::autoThrottling

(

bool

state

)

Change automatic throttle notification forwarding.

By default, throttle notifications are automatically forwarded from active to passive connectors. This may be disabled by setting the authoThrottling state to false.

Routing from/to an event to/from a passive connector will automatically create throttling notifications on the connector whenever the event is disabled. Routing form/to an event to/from an active connector will disable the event whenever a throttling notification comes in. Respective for unthrottle notifications.

Parameters

[in]

state

New throttle forwarding state

notifyThrottle()

template<class T >

void senf::ppi::ForwardingRoute::notifyThrottle ( T &  ob )

protected

notifyUnthrottle()

template<class T >

void senf::ppi::ForwardingRoute::notifyUnthrottle ( T &  ob )

protected

registerRoute()

template<class T >

void senf::ppi::ForwardingRoute::registerRoute ( T &  ob )

protected

throttled()

bool senf::ppi::ForwardingRoute::throttled

(

)

const

true, if the route is throttled

This member checks only the automatic throttling state. If autoThrottling() is false, this member will always return false.

unregisterRoute()

template<class T >

void senf::ppi::ForwardingRoute::unregisterRoute ( T &  ob )

protected

---

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

• Route.hh