senf::ppi::module::PassiveQueue Class Reference

Adaptor to connect active a pair of active connectors. More...

#include <senf/PPI/PassiveQueue.hh>

Inheritance diagram for senf::ppi::module::PassiveQueue:

Public Member Functions

 PassiveQueue ()
 
template<class ThrottlingDisc >
void throttlingDisc (ThrottlingDisc const &disc)
 Change the throttling discipline. More...
 
- Public Member Functions inherited from senf::ppi::module::Module
virtual ~Module ()
 

Public Attributes

connector::PassiveInput input
 
connector::PassiveOutput output
 

Additional Inherited Members

- Protected Member Functions inherited from senf::ppi::module::Module
 Module ()
 
Route< connector::InputConnector, connector::OutputConnector > & route (connector::InputConnector &input, connector::OutputConnector &output)
 Define flow information. More...
 
Route< connector::InputConnector, EventDescriptor > & route (connector::InputConnector &input, EventDescriptor &output)
 Define flow information. More...
 
Route< EventDescriptor, connector::OutputConnector > & route (EventDescriptor &input, connector::OutputConnector &output)
 Define flow information. More...
 
void noroute (connector::Connector &connector)
 Define terminal connectors. More...
 
template<class Target >
void registerEvent (EventDescriptor &descriptor, Target target)
 Register an external event. More...
 
ClockService::clock_type const & time () const
 Time-stamp of the currently processing event. More...
 
ClockService::clock_type const & now () const
 Current time of the currently processing event. More...
 
console::DirectoryNodesysConsoleDir () const
 
void destroy ()
 

Detailed Description

Adaptor to connect active a pair of active connectors.

This adaptor queue is used to connect two active connectors to each other. The queue receives data in it's passive input and places them in it's queue. Whenever data is requested from the passive output, a packet is dequeued.

The PassiveQueue will automatically throttle in both directions. Throttling on the input connector is the standard throttling as implemented in connector::PassiveInput<>. Additional forward throttling notifications are sent out whenever the queue is empty.

Definition at line 45 of file PassiveQueue.hh.

Constructor & Destructor Documentation

◆ PassiveQueue()

senf::ppi::module::PassiveQueue::PassiveQueue ( )

Definition at line 29 of file PassiveQueue.cc.

Member Function Documentation

◆ throttlingDisc()

template<class ThrottlingDisc >
void senf::ppi::module::PassiveQueue::throttlingDisc ( ThrottlingDisc const &  disc)

Change the throttling discipline.

This call changes the throttling discipline of the queue. This call is just forwarded to the input connector.

See also
connector::GenericPassiveInput::throttlingDisc()

Member Data Documentation

◆ input

connector::PassiveInput senf::ppi::module::PassiveQueue::input

Definition at line 48 of file PassiveQueue.hh.

◆ output

connector::PassiveOutput senf::ppi::module::PassiveQueue::output

Definition at line 51 of file PassiveQueue.hh.


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