tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple > Class Template Reference

join_node_base More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >:

Collaboration diagram for tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >:

Classes
class	join_node_base_operation

Public Types
typedef OutputTuple	output_type
typedef sender< output_type >::successor_type	successor_type
typedef join_node_FE< JP, InputTuple, OutputTuple >	input_ports_type
Public Types inherited from tbb::flow::interface10::sender< OutputTuple >
typedef OutputTuple	output_type
	The output type of this sender. More...
typedef internal::async_helpers< OutputTuple >::filtered_type	filtered_type
Public Types inherited from tbb::flow::interface10::internal::untyped_sender
typedef untyped_receiver	successor_type
	The successor type for this node. More...

Public Member Functions
	join_node_base (graph &g)
	join_node_base (const join_node_base &other)
template<typename FunctionTuple >
	join_node_base (graph &g, FunctionTuple f)
bool	register_successor (successor_type &r) __TBB_override
	Add a new successor to this node. More...
bool	remove_successor (successor_type &r) __TBB_override
	Removes a successor from this node. More...
bool	try_get (output_type &v) __TBB_override
	Request an item from the sender. More...
Public Member Functions inherited from tbb::flow::interface10::graph_node
	graph_node (graph &g)
virtual	~graph_node ()
Public Member Functions inherited from tbb::flow::interface10::sender< OutputTuple >
virtual bool	try_reserve (OutputTuple &)
	Reserves an item in the sender. More...
Public Member Functions inherited from tbb::flow::interface10::internal::untyped_sender
virtual	~untyped_sender ()
virtual bool	try_release ()
	Releases the reserved item. More...
virtual bool	try_consume ()
	Consumes the reserved item. More...

Protected Member Functions
void	reset_node (reset_flags f) __TBB_override
Protected Member Functions inherited from tbb::flow::interface10::sender< OutputTuple >
virtual bool	try_get_wrapper (void *p, bool is_async) __TBB_override
virtual bool	try_reserve_wrapper (void *p, bool is_async) __TBB_override
Protected Member Functions inherited from tbb::flow::interface10::internal::untyped_sender
template<typename X >
bool	try_get (X &t)
	Request an item from the sender. More...
template<typename X >
bool	try_reserve (X &t)
	Reserves an item in the sender. More...

Protected Attributes
graph &	my_graph
Protected Attributes inherited from tbb::flow::interface10::graph_node
graph &	my_graph
graph_node *	next
graph_node *	prev

Private Types
enum	op_type {   reg_succ, rem_succ, try__get, do_fwrd,   do_fwrd_bypass }
enum	op_stat { WAIT =0, SUCCEEDED, FAILED }
typedef join_node_base< JP, InputTuple, OutputTuple >	class_type
typedef internal::aggregating_functor< class_type, join_node_base_operation >	handler_type

Private Member Functions
void	handle_operations (join_node_base_operation *op_list)
task *	forward_task ()

Private Attributes
bool	forwarder_busy
aggregator< handler_type, join_node_base_operation >	my_aggregator
broadcast_cache< output_type, null_rw_mutex >	my_successors

Friends
class	internal::aggregating_functor< class_type, join_node_base_operation >
class	forward_task_bypass< join_node_base< JP, InputTuple, OutputTuple > >

Detailed Description

template<typename JP, typename InputTuple, typename OutputTuple>
class tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >

join_node_base

Definition at line 867 of file flow_graph.h.

Member Typedef Documentation

class_type

template<typename JP , typename InputTuple , typename OutputTuple >

typedef join_node_base<JP,InputTuple,OutputTuple> tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::class_type

private

Definition at line 1290 of file flow_graph.h.

handler_type

template<typename JP , typename InputTuple , typename OutputTuple >

typedef internal::aggregating_functor<class_type, join_node_base_operation> tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::handler_type

private

Definition at line 1311 of file flow_graph.h.

input_ports_type

template<typename JP , typename InputTuple , typename OutputTuple >

typedef join_node_FE<JP, InputTuple, OutputTuple> tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::input_ports_type

Definition at line 1272 of file flow_graph.h.

output_type

template<typename JP , typename InputTuple , typename OutputTuple >

typedef OutputTuple tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::output_type

Definition at line 1269 of file flow_graph.h.

successor_type

template<typename JP , typename InputTuple , typename OutputTuple >

typedef sender<output_type>::successor_type tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::successor_type

Definition at line 1271 of file flow_graph.h.

Member Enumeration Documentation

op_stat

template<typename JP , typename InputTuple , typename OutputTuple >

enum tbb::flow::interface10::internal::join_node_base::op_stat

private

Enumerator
WAIT
SUCCEEDED
FAILED

Definition at line 1289 of file flow_graph.h.

{

op_type

template<typename JP , typename InputTuple , typename OutputTuple >

enum tbb::flow::interface10::internal::join_node_base::op_type

private

Enumerator
reg_succ
rem_succ
try__get
do_fwrd
do_fwrd_bypass

Definition at line 1284 of file flow_graph.h.

                                      { return my_output_ports; }

protected:

Constructor & Destructor Documentation

join_node_base() [1/3]

template<typename JP , typename InputTuple , typename OutputTuple >

tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::join_node_base ( graph &  g )

inline

Definition at line 1396 of file flow_graph.h.

                     : public graph_node, public receiver<T>, public sender<T> {
public:
    typedef T input_type;
    typedef T output_type;

join_node_base() [2/3]

template<typename JP , typename InputTuple , typename OutputTuple >

tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::join_node_base ( const join_node_base< JP, InputTuple, OutputTuple > &  other )

inline

Definition at line 1402 of file flow_graph.h.

       :
    internal::broadcast_cache<input_type> my_successors;

join_node_base() [3/3]

template<typename JP , typename InputTuple , typename OutputTuple >

template<typename FunctionTuple >

tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::join_node_base ( graph &  g, FunctionTuple  f  )

inline

Definition at line 1411 of file flow_graph.h.

      :

    explicit broadcast_node(graph& g) : graph_node(g) {

Member Function Documentation

forward_task()

template<typename JP , typename InputTuple , typename OutputTuple >

task* tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::forward_task ( )

inlineprivate

Definition at line 1479 of file flow_graph.h.

                                              {

handle_operations()

template<typename JP , typename InputTuple , typename OutputTuple >

void tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::handle_operations ( join_node_base_operation *  op_list )

inlineprivate

Definition at line 1316 of file flow_graph.h.

                                                                  {}

    built_predecessors_type &built_predecessors() __TBB_override { return my_predessors; }

    built_predecessors_type my_predessors;
#endif  /* TBB_DEPRECATED_FLOW_NODE_EXTRACTION */

private:
    output_ports_type my_output_ports;
};

template <typename Output, typename Policy = internal::Policy<void> >
class continue_node : public graph_node, public internal::continue_input<Output, Policy>,
                      public internal::function_output<Output> {
public:
    typedef continue_msg input_type;
    typedef Output output_type;
    typedef internal::continue_input<Output, Policy> input_impl_type;
    typedef internal::function_output<output_type> fOutput_type;
    typedef typename input_impl_type::predecessor_type predecessor_type;
    typedef typename fOutput_type::successor_type successor_type;

    template <typename Body >
    continue_node( graph &g, Body body ) :
        graph_node(g), input_impl_type( g, body ) {
        tbb::internal::fgt_node_with_body( tbb::internal::FLOW_CONTINUE_NODE, &this->my_graph,
                                           static_cast<receiver<input_type> *>(this),
                                           static_cast<sender<output_type> *>(this), this->my_body );
    }


    template <typename Body >
    continue_node( graph &g, int number_of_predecessors, Body body ) :
        graph_node(g), input_impl_type( g, number_of_predecessors, body ) {
        tbb::internal::fgt_node_with_body( tbb::internal::FLOW_CONTINUE_NODE, &this->my_graph,
                                           static_cast<receiver<input_type> *>(this),
                                           static_cast<sender<output_type> *>(this), this->my_body );
    }

    continue_node( const continue_node& src ) :
        graph_node(src.my_graph), input_impl_type(src),
        internal::function_output<Output>() {
        tbb::internal::fgt_node_with_body( tbb::internal::FLOW_CONTINUE_NODE, &this->my_graph,
                                           static_cast<receiver<input_type> *>(this),
                                           static_cast<sender<output_type> *>(this), this->my_body );
    }

#if TBB_PREVIEW_FLOW_GRAPH_TRACE
    void set_name( const char *name ) __TBB_override {
        tbb::internal::fgt_node_desc( this, name );
    }
#endif

#if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
    void extract() __TBB_override {
        input_impl_type::my_built_predecessors.receiver_extract(*this);
        successors().built_successors().sender_extract(*this);
    }
#endif

protected:
    template< typename R, typename B > friend class run_and_put_task;
    template<typename X, typename Y> friend class internal::broadcast_cache;
    template<typename X, typename Y> friend class internal::round_robin_cache;
    using input_impl_type::try_put_task;
    internal::broadcast_cache<output_type> &successors () __TBB_override { return fOutput_type::my_successors; }

    void reset_node(reset_flags f) __TBB_override {
        input_impl_type::reset_receiver(f);
        if(f & rf_clear_edges)successors().clear();
        __TBB_ASSERT(!(f & rf_clear_edges) || successors().empty(), "continue_node not reset");
    }
};  // continue_node

register_successor()

template<typename JP , typename InputTuple , typename OutputTuple >

bool tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::register_successor ( successor_type &  r )

inlinevirtual

Add a new successor to this node.

Implements tbb::flow::interface10::internal::untyped_sender.

Definition at line 1417 of file flow_graph.h.

                                                :
        graph_node(src.my_graph), receiver<T>(), sender<T>()

remove_successor()

template<typename JP , typename InputTuple , typename OutputTuple >

bool tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::remove_successor ( successor_type &  r )

inlinevirtual

Removes a successor from this node.

Implements tbb::flow::interface10::internal::untyped_sender.

Definition at line 1423 of file flow_graph.h.

    {
        my_successors.set_owner( this );
        tbb::internal::fgt_node( tbb::internal::FLOW_BROADCAST_NODE, &this->my_graph,
                                 static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );

References tbb::internal::fgt_node(), and tbb::flow::interface10::internal::successor_cache< T, M >::set_owner().

Here is the call graph for this function:

reset_node()

template<typename JP , typename InputTuple , typename OutputTuple >

void tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::reset_node ( reset_flags  f )

inlineprotectedvirtual

Implements tbb::flow::interface10::graph_node.

Definition at line 1470 of file flow_graph.h.

                                                                 { return my_built_predecessors; }

    void internal_add_built_predecessor( predecessor_type &p) __TBB_override {

try_get()

template<typename JP , typename InputTuple , typename OutputTuple >

bool tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::try_get ( output_type &  )

inlinevirtual

Request an item from the sender.

Reimplemented from tbb::flow::interface10::sender< OutputTuple >.

Definition at line 1429 of file flow_graph.h.

                                                     {
        tbb::internal::fgt_node_desc( this, name );
    }

References tbb::internal::fgt_node_desc(), and name.

Here is the call graph for this function:

Friends And Related Function Documentation

forward_task_bypass< join_node_base< JP, InputTuple, OutputTuple > >

template<typename JP , typename InputTuple , typename OutputTuple >

friend class forward_task_bypass< join_node_base< JP, InputTuple, OutputTuple > >

friend

Definition at line 1478 of file flow_graph.h.

internal::aggregating_functor< class_type, join_node_base_operation >

template<typename JP , typename InputTuple , typename OutputTuple >

friend class internal::aggregating_functor< class_type, join_node_base_operation >

friend

Definition at line 1312 of file flow_graph.h.

Member Data Documentation

forwarder_busy

template<typename JP , typename InputTuple , typename OutputTuple >

bool tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::forwarder_busy

private

Definition at line 1313 of file flow_graph.h.

my_aggregator

template<typename JP , typename InputTuple , typename OutputTuple >

aggregator<handler_type, join_node_base_operation> tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::my_aggregator

private

Definition at line 1314 of file flow_graph.h.

my_graph

template<typename JP , typename InputTuple , typename OutputTuple >

graph& tbb::flow::interface10::graph_node::my_graph

protected

Definition at line 355 of file _flow_graph_impl.h.

my_successors

template<typename JP , typename InputTuple , typename OutputTuple >

broadcast_cache<output_type, null_rw_mutex> tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >::my_successors

private

Definition at line 1476 of file flow_graph.h.

---

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

• flow_graph.h