broadcast_node

[flow_graph.broadcast_node]

A node that broadcasts incoming messages to all of its successors.

// Defined in header <tbb/flow_graph.h>
namespace tbb {
namespace flow {

    template< typename T >
    class broadcast_node :
    public graph_node, public receiver<T>, public sender<T> {
    public:
        explicit broadcast_node( graph &g );
        broadcast_node( const broadcast_node &src );

        bool try_put( const T &v );
        bool try_get( T &v );
    };

} // namespace flow
} // namespace tbb

Requirements:

  • T type must meet the CopyConstructible requirements from [copyconstructible] and CopyAssignable requirements from [copyassignable] ISO C++ Standard section.

broadcast_node is a graph_node, receiver<T>, and sender<T>.

broadcast_node has a discarding and broadcast-push properties.

All messages are forwarded immediately to all successors.

Member functions

explicit broadcast_node(graph &g)

Constructs an object of type broadcast_node that belongs to the graph g.

broadcast_node(const broadcast_node &src)

Constructs an object of type broadcast_node that belongs to the same graph g as src. The list of predecessors, the list of successors, and the messages in the buffer are not copied.

bool try_put(const input_type &v)

Adds v to all successors.

Returns: always returns true, even if it was unable to successfully forward the message to any of its successors.

bool try_get(output_type &v)

If the internal buffer is valid, assigns the value to v.

Returns: true if v is assigned to; false, otherwise.