senf::ppi::module::PassiveQueueingSocketSink< Writer > Class Template Reference

QueueingSocketSink. More...

#include <senf/PPI/QueueingSocketSink.hh>

Inheritance diagram for senf::ppi::module::PassiveQueueingSocketSink< Writer >:

Public Types

typedef Writer::Handle Handle
 Handle type requested by writer. More...
 
typedef Writer::PacketType PacketType
 

Public Member Functions

 PassiveQueueingSocketSink (Handle const &handle, QueueingAlgorithm::ptr qAlgorithm)
 
Writer & writer ()
 Access the Writer. More...
 
Handlehandle ()
 Access handle. More...
 
void handle (Handle const &handle)
 Set handle. More...
 
QueueingAlgorithmqAlgorithm () const
 
void qAlgorithm (QueueingAlgorithm::ptr qAlgorithm)
 
- Public Member Functions inherited from senf::ppi::module::Module
virtual ~Module ()
 

Public Attributes

connector::PassiveInput< PacketTypeinput
 Input connector from which data is received. More...
 
console::ScopedDirectory dir
 

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...
 
virtual void v_init ()
 Called after module setup. More...
 
console::DirectoryNodesysConsoleDir () const
 
void destroy ()
 

Detailed Description

template<class Writer = ConnectedDgramWriter>
class senf::ppi::module::PassiveQueueingSocketSink< Writer >

QueueingSocketSink.

Definition at line 35 of file QueueingSocketSink.hh.

Member Typedef Documentation

◆ Handle

template<class Writer = ConnectedDgramWriter>
typedef Writer::Handle senf::ppi::module::PassiveQueueingSocketSink< Writer >::Handle

Handle type requested by writer.

Definition at line 37 of file QueueingSocketSink.hh.

◆ PacketType

template<class Writer = ConnectedDgramWriter>
typedef Writer::PacketType senf::ppi::module::PassiveQueueingSocketSink< Writer >::PacketType

Definition at line 41 of file QueueingSocketSink.hh.

Constructor & Destructor Documentation

◆ PassiveQueueingSocketSink()

template<class Writer = ConnectedDgramWriter>
senf::ppi::module::PassiveQueueingSocketSink< Writer >::PassiveQueueingSocketSink ( Handle const &  handle,
QueueingAlgorithm::ptr  qAlgorithm 
)
explicit

Member Function Documentation

◆ handle() [1/2]

template<class Writer = ConnectedDgramWriter>
Handle& senf::ppi::module::PassiveQueueingSocketSink< Writer >::handle ( )

Access handle.

◆ handle() [2/2]

template<class Writer = ConnectedDgramWriter>
void senf::ppi::module::PassiveQueueingSocketSink< Writer >::handle ( Handle const &  handle)

Set handle.

Assigning an empty or in-valid() handle will disable the module until a new valid handle is assigned.

◆ qAlgorithm() [1/2]

template<class Writer = ConnectedDgramWriter>
QueueingAlgorithm& senf::ppi::module::PassiveQueueingSocketSink< Writer >::qAlgorithm ( ) const

◆ qAlgorithm() [2/2]

template<class Writer = ConnectedDgramWriter>
void senf::ppi::module::PassiveQueueingSocketSink< Writer >::qAlgorithm ( QueueingAlgorithm::ptr  qAlgorithm)

◆ writer()

template<class Writer = ConnectedDgramWriter>
Writer& senf::ppi::module::PassiveQueueingSocketSink< Writer >::writer ( )

Access the Writer.

Member Data Documentation

◆ dir

template<class Writer = ConnectedDgramWriter>
console::ScopedDirectory senf::ppi::module::PassiveQueueingSocketSink< Writer >::dir

Definition at line 44 of file QueueingSocketSink.hh.

◆ input

template<class Writer = ConnectedDgramWriter>
connector::PassiveInput<PacketType> senf::ppi::module::PassiveQueueingSocketSink< Writer >::input

Input connector from which data is received.

Definition at line 43 of file QueueingSocketSink.hh.


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