flow::samples::generic::delay< T > Class Template Reference

Concrete transformer that adds a delay to a packet's consumption time. More...

#include <generic.h>

Inheritance diagram for flow::samples::generic::delay< T >:

Collaboration diagram for flow::samples::generic::delay< T >:

Public Member Functions
template<typename Duration >
	delay (const Duration &offset_r, const std::string &name_r="delay")
virtual void	ready (size_t)
	Implementation of consumer::ready().
Public Member Functions inherited from flow::transformer< T, T >
	transformer (const std::string &name_r, const size_t ins, const size_t outs)
virtual std::string	rename (const std::string &name_r)
	Overrides named::rename.
Public Member Functions inherited from flow::consumer< T >
	consumer (const std::string &name_r, const size_t ins)
virtual size_t	ins () const
	Returns the number of input pins.
virtual inpin< T > &	input (const size_t n)
	Returns a reference to an input pin.
virtual const inpin< T > &	input (const size_t n) const
	Returns a const reference to an input pin.
virtual inputs_t &	inputs ()
	Returns a reference to the container of input pins.
virtual const inputs_t &	inputs () const
	Returns a const reference to the container of input pins.
Public Member Functions inherited from flow::node
	node (const std::string &name_r)
	node (node &&node_rr)
	Move constructor.
virtual state::type	state () const
	Returns the node's state.
virtual void	started ()
	Indicates the node has been started.
virtual void	paused ()
	Indicates the node has been paused.
virtual void	stopped ()
	Indicates the node has been stopped.
Public Member Functions inherited from flow::named
	named (const std::string &name_r)
	Constructor the takes a name.
	named (named &&name_rr)
	Move constructor.
	named (const named &name_r)
	Copy constructor.
virtual const std::string &	name () const
	A const reference to this object's name.
Public Member Functions inherited from flow::producer< T >
	producer (const std::string &name_r, const size_t outs)
virtual size_t	outs () const
	Returns the number of output pins.
virtual outpin< T > &	output (const size_t n)
	Returns a reference to an outpin pin.
virtual const outpin< T > &	output (const size_t n) const
	Returns a const reference to an outpin pin.
virtual outputs_t &	outputs ()
	Returns a reference to the container of output pins.
virtual const outputs_t &	outputs () const
	Returns a const reference to the container of output pins.

Additional Inherited Members
Protected Member Functions inherited from flow::transformer< T, T >
virtual void	sever ()
	Disconnect all pins.
virtual void	operator() ()
	Implementation of node::operator()().
Protected Attributes inherited from flow::node
std::condition_variable	d_transition_cv
	The condition variable to monitor the node's state.
std::mutex	d_transition_m
	The mutex to lock when waiting on d_transition_cv.

Detailed Description

template<typename T>
class flow::samples::generic::delay< T >

Concrete transformer that adds a delay to a packet's consumption time.

Constructor & Destructor Documentation

template<typename T >

template<typename Duration >

flow::samples::generic::delay< T >::delay ( const Duration &  offset_r, const std::string &  name_r = "delay< T >"  )

inline

Parameters

offset_r	The delay to add to the packets' consumption time.
name_r	The name to give this node.

Member Function Documentation

template<typename T >

virtual void flow::samples::generic::delay< T >::ready ( size_t  )

inlinevirtual

Implementation of consumer::ready().

If a packet has no set consumption time, then its consumption is set to the time at which this node has received the packet plus the given delay.

Implements flow::transformer< T, T >.

---

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

• include/samples/generic.h