senf::ppi::ForwardingRoute Class Reference
Forwarding route base class. More...#include <senf/PPI/Route.hh>
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 81 of file Route.hh.
Public Member Functions |
|
| bool | autoThrottling () const |
| Query current autoThrottling state. |
|
| void | autoThrottling (bool state) |
| Change automatic throttle notification forwarding. |
|
| bool | throttled () const |
true, if the route is throttled |
|
Protected Member Functions |
|
| ForwardingRoute (module::Module &module) | |
| 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) |
Constructor & Destructor Documentation
| senf::ppi::ForwardingRoute:: | ||||
| ForwardingRoute | ( | module::Module & | module | ) |
Member Function Documentation
| 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
| bool senf::ppi::ForwardingRoute:: | ||||
| autoThrottling | () | |||
| void senf::ppi::ForwardingRoute:: | ||||
| notifyThrottle | ( | T & | ob | ) |
| void senf::ppi::ForwardingRoute:: | ||||
| notifyUnthrottle | ( | T & | ob | ) |
| void senf::ppi::ForwardingRoute:: | ||||
| registerRoute | ( | T & | ob | ) |
| bool senf::ppi::ForwardingRoute:: | ||||
| throttled | () | |||
true, if the route is throttled
This member checks only the automatic throttling state. If autoThrottling() is false, this member will always return false.
| void senf::ppi::ForwardingRoute:: | ||||
| unregisterRoute | ( | T & | ob | ) |
The documentation for this class was generated from the following files: