flow_graph.h File Reference

The graph related classes and functions. More...

Classes
class	tbb::flow::interface7::internal::successor_cache< T, M >
class	tbb::flow::interface7::internal::broadcast_cache< T, M >
class	tbb::flow::interface7::internal::round_robin_cache< T, M >
class	tbb::flow::interface7::continue_msg
	An empty class used for messages that mean "I'm done". More...
class	tbb::flow::interface7::sender< T >
	Pure virtual template class that defines a sender of messages of type T. More...
class	tbb::flow::interface7::receiver< T >
	Pure virtual template class that defines a receiver of messages of type T. More...
class	tbb::flow::interface7::sender< T >
	Pure virtual template class that defines a sender of messages of type T. More...
class	tbb::flow::interface7::limiter_node< T >
	Forwards messages only if the threshold has not been reached. More...
class	tbb::flow::interface7::run_and_put_task< R, B >
class	tbb::flow::interface7::receiver< T >
	Pure virtual template class that defines a receiver of messages of type T. More...
class	tbb::flow::interface7::continue_receiver
	Base class for receivers of completion messages. More...
class	tbb::flow::interface7::graph_iterator< GraphContainerType, GraphNodeType >
class	tbb::flow::interface7::graph
	The graph class. More...
class	tbb::flow::interface7::graph_node
	The base of all graph nodes. More...
class	tbb::flow::interface7::source_node< Output >
	An executable node that acts as a source, i.e. it has no predecessors. More...
class	tbb::flow::interface7::function_node< Input, Output, graph_buffer_policy, Allocator >
	Implements a function node that supports Input -> Output. More...
class	tbb::flow::interface7::function_node< Input, Output, queueing, Allocator >
	Implements a function node that supports Input -> Output. More...
class	tbb::flow::interface7::multifunction_node< Input, Output, graph_buffer_policy, Allocator >
	implements a function node that supports Input -> (set of outputs) More...
class	tbb::flow::interface7::multifunction_node< Input, Output, queueing, Allocator >
class	tbb::flow::interface7::split_node< TupleType, Allocator >
	split_node: accepts a tuple as input, forwards each element of the tuple to its More...
class	tbb::flow::interface7::continue_node< Output >
	Implements an executable node that supports continue_msg -> Output. More...
class	tbb::flow::interface7::overwrite_node< T >
class	tbb::flow::interface7::write_once_node< T >
class	tbb::flow::interface7::broadcast_node< T >
	Forwards messages of type T to all successors. More...
class	tbb::flow::interface7::buffer_node< T, A >
	Forwards messages in arbitrary order. More...
class	tbb::flow::interface7::buffer_node< T, A >::buffer_operation
class	tbb::flow::interface7::queue_node< T, A >
	Forwards messages in FIFO order. More...
class	tbb::flow::interface7::sequencer_node< T, A >
	Forwards messages in sequence order. More...
class	tbb::flow::interface7::priority_queue_node< T, Compare, A >
	Forwards messages in priority order. More...
class	tbb::flow::interface7::limiter_node< T >
	Forwards messages only if the threshold has not been reached. More...
class	tbb::flow::interface7::join_node< OutputTuple, JP >
class	tbb::flow::interface7::join_node< OutputTuple, reserving >
class	tbb::flow::interface7::join_node< OutputTuple, queueing >
class	tbb::flow::interface7::join_node< OutputTuple, tag_matching >
class	tbb::flow::interface7::or_node< InputTuple >

Namespaces
	tbb
	The namespace tbb contains all components of the library.

Constant Groups
	tbb
	The namespace tbb contains all components of the library.

Enumerations
enum	concurrency { unlimited = 0, serial = 1 }
	An enumeration the provides the two most common concurrency levels: unlimited and serial.

Functions
static tbb::task *	tbb::flow::interface7::combine_tasks (tbb::task *left, tbb::task *right)
template<typename T >
void	tbb::flow::interface7::make_edge (sender< T > &p, receiver< T > &s)
	Makes an edge between a single predecessor and a single successor.
template<typename T >
void	tbb::flow::interface7::remove_edge (sender< T > &p, receiver< T > &s)
	Makes an edge between a single predecessor and a single successor.
template<typename Body , typename Node >
Body	tbb::flow::interface7::copy_body (Node &n)
	Returns a copy of the body from a function or continue node.

Variables
static tbb::task *const	tbb::flow::interface7::SUCCESSFULLY_ENQUEUED = (task *)-1

Detailed Description

The graph related classes and functions.

There are some applications that best express dependencies as messages passed between nodes in a graph. These messages may contain data or simply act as signals that a predecessors has completed. The graph class and its associated node classes can be used to express such applcations.