senf::ppi::module::debug::PassiveSink Class Reference

Debug packet sink with passive input. More...

#include <senf/PPI/DebugModules.hh>

Inheritance diagram for senf::ppi::module::debug::PassiveSink:

Public Types

typedef Queue::size_type size_type
 
typedef Queue::const_iterator iterator
 

Public Member Functions

 PassiveSink ()
 
void throttle ()
 Throttle input connection. More...
 
void unthrottle ()
 Unthrottle input connection. More...
 
bool empty ()
 true, if queue is empty More...
 
size_type size ()
 number of packets in the queue More...
 
iterator begin ()
 begin iterator of packets in the queue More...
 
iterator end ()
 past-the-end iterator of packets in the queue More...
 
Packet front ()
 first packet in the queue More...
 
Packet pop_front ()
 remove and return first packet in the queue More...
 
void clear ()
 clear the queue More...
 
- Public Member Functions inherited from senf::ppi::module::Module
virtual ~Module ()
 

Public Attributes

connector::PassiveInput input
 

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

Debug packet sink with passive input.

This module provides a queue for the network to write packets into. The packets can then later be analyzed.

Definition at line 150 of file DebugModules.hh.

Member Typedef Documentation

◆ iterator

◆ size_type

Definition at line 158 of file DebugModules.hh.

Constructor & Destructor Documentation

◆ PassiveSink()

senf::ppi::module::debug::PassiveSink::PassiveSink ( )

Member Function Documentation

◆ begin()

iterator senf::ppi::module::debug::PassiveSink::begin ( )

begin iterator of packets in the queue

◆ clear()

void senf::ppi::module::debug::PassiveSink::clear ( )

clear the queue

◆ empty()

bool senf::ppi::module::debug::PassiveSink::empty ( )

true, if queue is empty

◆ end()

iterator senf::ppi::module::debug::PassiveSink::end ( )

past-the-end iterator of packets in the queue

◆ front()

Packet senf::ppi::module::debug::PassiveSink::front ( )

first packet in the queue

◆ pop_front()

Packet senf::ppi::module::debug::PassiveSink::pop_front ( )

remove and return first packet in the queue

◆ size()

size_type senf::ppi::module::debug::PassiveSink::size ( )

number of packets in the queue

◆ throttle()

void senf::ppi::module::debug::PassiveSink::throttle ( )

Throttle input connection.

◆ unthrottle()

void senf::ppi::module::debug::PassiveSink::unthrottle ( )

Unthrottle input connection.

Member Data Documentation

◆ input

connector::PassiveInput senf::ppi::module::debug::PassiveSink::input

Definition at line 161 of file DebugModules.hh.


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