Concrete consumer that outputs packets to a parameter std::ostream. More...

#include <generic.h>

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

[legend]

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

[legend]

Public Member Functions
	ostreamer (std::ostream &o_r, const std::string &name_r="ostreamer")

virtual void	stopped ()
	Implementation of node::stopped().

virtual void	ready (size_t)
	Implementation of consumer::ready()

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.

virtual std::string	rename (const std::string &name_r)
	Overrides named::rename.

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.

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.

Additional Inherited Members
Protected Member Functions inherited from flow::consumer< T >
virtual void	disconnect (size_t pin)
	Disconnect an inpin of this consumer.

virtual void	sever ()
	Disconnect all pins.

virtual bool	incoming ()
	Tests whether there are any packets at any of the inpins.

virtual void	operator() ()
	The node's execution function.

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

Concrete consumer that outputs packets to a parameter std::ostream.

Constructor & Destructor Documentation

template<typename T >

flow::samples::generic::ostreamer< T >::ostreamer	(	std::ostream &	o_r,
		const std::string &	name_r = `"ostreamer< T >"`
	)

inline

This consumer has only one input.

Parameters

o_r	Reference to the output stream.
name_r	The name to give this node.

template<typename T >

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

inlinevirtual

Implementation of consumer::ready()

If a packet has no consumption time specified, the packet is streamed immediately. If a packet has a consumption time specified, and that time is:

in the future: this function sleeps until that time to stream it out or sleeps until the node was stopped.
in the past: the packet is unused and lost.

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