senf::ppi::module::ActiveQueueSocketSource< Packet, Connector > Class Template Reference

Reader for module::ActiveSocketSource (read from socket packet queue) More...

#include <senf/PPI/QueueSocketSourceSink.hh>

Inheritance diagram for senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >:

Public Types

typedef Packet PacketType
 
typedef senf::ClientSocketHandle< senf::MakeSocketPolicy< senf::QueueReadPolicy, senf::DatagramFramingPolicy >::policy > Handle
 

Public Member Functions

 ActiveQueueSocketSource (unsigned burst=1)
 
 ActiveQueueSocketSource (Handle const &handle, unsigned burst=1)
 
Handle handle () const
 
void handle (Handle const &handle)
 
unsigned maxBurst () const
 
void maxBurst (unsigned burst)
 
void flush ()
 
void setREDFilterCallback (REDFilterCallback const &cb)
 
std::pair< unsigned, unsigned > dropped ()
 
- Public Member Functions inherited from senf::ppi::module::Module
virtual ~Module ()
 

Public Attributes

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

Detailed Description

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
class senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >

Reader for module::ActiveSocketSource (read from socket packet queue)

This read helper will read a datagram from a socket providing the queue read API. The Packet will be instantiated utilizing the queue memory using the external packet memory manager support.

See also
senf::QueueReadPolicy

Definition at line 62 of file QueueSocketSourceSink.hh.

Member Typedef Documentation

◆ Handle

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
typedef senf::ClientSocketHandle< senf::MakeSocketPolicy< senf::QueueReadPolicy, senf::DatagramFramingPolicy >::policy > senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::Handle

Definition at line 70 of file QueueSocketSourceSink.hh.

◆ PacketType

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
typedef Packet senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::PacketType

Definition at line 65 of file QueueSocketSourceSink.hh.

Constructor & Destructor Documentation

◆ ActiveQueueSocketSource() [1/2]

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::ActiveQueueSocketSource ( unsigned  burst = 1)
explicit

◆ ActiveQueueSocketSource() [2/2]

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::ActiveQueueSocketSource ( Handle const &  handle,
unsigned  burst = 1 
)
explicit

Member Function Documentation

◆ dropped()

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
std::pair<unsigned,unsigned> senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::dropped ( )

◆ flush()

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
void senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::flush ( )

◆ handle() [1/2]

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
Handle senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::handle ( ) const

◆ handle() [2/2]

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
void senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::handle ( Handle const &  handle)

◆ maxBurst() [1/2]

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
unsigned senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::maxBurst ( ) const

◆ maxBurst() [2/2]

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
void senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::maxBurst ( unsigned  burst)

◆ setREDFilterCallback()

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
void senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::setREDFilterCallback ( REDFilterCallback const &  cb)

Member Data Documentation

◆ output

template<class Packet = DataPacket, class Connector = connector::ActiveOutput<Packet>>
Connector senf::ppi::module::ActiveQueueSocketSource< Packet, Connector >::output

Definition at line 72 of file QueueSocketSourceSink.hh.


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