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

join_node_base More...

#include <flow_graph.h>

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

Collaboration diagram for tbb::flow::interface11::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::interface11::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::interface11::graph_node
	graph_node (graph &g)
virtual	~graph_node ()
Public Member Functions inherited from tbb::flow::interface11::sender< OutputTuple >
virtual bool	try_reserve (OutputTuple &)
	Reserves an item in the sender. More...
Public Member Functions inherited from tbb::flow::interface11::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::interface11::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::interface11::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::interface11::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 }
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 > >

Additional Inherited Members
Public Attributes inherited from tbb::flow::interface11::sender< OutputTuple >
__TBB_DEPRECATED typedef OutputTuple	output_type
	The output type of this sender. More...
__TBB_DEPRECATED typedef internal::async_helpers< OutputTuple >::filtered_type	filtered_type

Detailed Description

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

join_node_base

Definition at line 868 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::interface11::internal::join_node_base< JP, InputTuple, OutputTuple >::class_type

private

Definition at line 1289 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::interface11::internal::join_node_base< JP, InputTuple, OutputTuple >::handler_type

private

Definition at line 1310 of file flow_graph.h.

input_ports_type

template<typename JP , typename InputTuple , typename OutputTuple >

typedef join_node_FE<JP, InputTuple, OutputTuple> tbb::flow::interface11::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::interface11::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::interface11::internal::join_node_base< JP, InputTuple, OutputTuple >::successor_type

Definition at line 1271 of file flow_graph.h.

Member Enumeration Documentation

op_type

template<typename JP , typename InputTuple , typename OutputTuple >

enum tbb::flow::interface11::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.

                                  {
            v = my_cached_item;
            my_has_cached_item = false;

Constructor & Destructor Documentation

join_node_base() [1/3]

template<typename JP , typename InputTuple , typename OutputTuple >

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

inline

Definition at line 1395 of file flow_graph.h.

References tbb::internal::fgt_begin_body(), and tbb::internal::fgt_end_body().

                                   {
            tbb::internal::fgt_begin_body( my_body );
            bool r = (*my_body)(my_cached_item);
            tbb::internal::fgt_end_body( my_body );
            if (r) {

Here is the call graph for this function:

join_node_base() [2/3]

template<typename JP , typename InputTuple , typename OutputTuple >

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

inline

Definition at line 1401 of file flow_graph.h.

                                  {
            v = my_cached_item;
            my_reserved = true;
            return true;
        } else {

join_node_base() [3/3]

template<typename JP , typename InputTuple , typename OutputTuple >

template<typename FunctionTuple >

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

inline

Definition at line 1410 of file flow_graph.h.

                            {

Member Function Documentation

forward_task()

template<typename JP , typename InputTuple , typename OutputTuple >

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

inlineprivate

Definition at line 1478 of file flow_graph.h.

handle_operations()

template<typename JP , typename InputTuple , typename OutputTuple >

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

inlineprivate

Definition at line 1315 of file flow_graph.h.

                                       {
        spin_mutex::scoped_lock lock(my_mutex);
        __TBB_ASSERT( my_reserved && my_has_cached_item, "releasing non-existent reservation" );
        my_reserved = false;
        if(!my_successors.empty())
            spawn_put();
        return true;
    }

    bool try_consume( ) __TBB_override {
        spin_mutex::scoped_lock lock(my_mutex);
        __TBB_ASSERT( my_reserved && my_has_cached_item, "consuming non-existent reservation" );
        my_reserved = false;
        my_has_cached_item = false;
        if ( !my_successors.empty() ) {
            spawn_put();
        }
        return true;
    }

    void activate() {
        spin_mutex::scoped_lock lock(my_mutex);
        my_active = true;
        if (!my_successors.empty())
            spawn_put();
    }

    template<typename Body>
    Body copy_function_object() {
        internal::source_body<output_type> &body_ref = *this->my_body;
        return dynamic_cast< internal::source_body_leaf<output_type, Body> & >(body_ref).get_body();
    }

#if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
    void extract( ) __TBB_override {
        my_successors.built_successors().sender_extract(*this);   // removes "my_owner" == this from each successor
        my_active = init_my_active;
        my_reserved = false;
        if(my_has_cached_item) my_has_cached_item = false;
    }
#endif

protected:

    void reset_node( reset_flags f) __TBB_override {
        my_active = init_my_active;
        my_reserved =false;
        if(my_has_cached_item) {
            my_has_cached_item = false;
        }
        if(f & rf_clear_edges) my_successors.clear();
        if(f & rf_reset_bodies) {
            internal::source_body<output_type> *tmp = my_init_body->clone();
            delete my_body;
            my_body = tmp;
        }
        if(my_active)
            internal::add_task_to_graph_reset_list(this->my_graph, create_put_task());
    }

private:
    spin_mutex my_mutex;
    bool my_active;
    bool init_my_active;
    internal::source_body<output_type> *my_body;
    internal::source_body<output_type> *my_init_body;
    internal::broadcast_cache< output_type > my_successors;
    bool my_reserved;
    bool my_has_cached_item;
    output_type my_cached_item;

    // used by apply_body_bypass, can invoke body of node.
    bool try_reserve_apply_body(output_type &v) {
        spin_mutex::scoped_lock lock(my_mutex);
        if ( my_reserved ) {

register_successor()

template<typename JP , typename InputTuple , typename OutputTuple >

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

inlinevirtual

Add a new successor to this node.

Implements tbb::flow::interface11::internal::untyped_sender.

Definition at line 1416 of file flow_graph.h.

                            {
        return ( new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
                        internal:: source_task_bypass < source_node< output_type > >( *this ) );
    }

remove_successor()

template<typename JP , typename InputTuple , typename OutputTuple >

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

inlinevirtual

Removes a successor from this node.

Implements tbb::flow::interface11::internal::untyped_sender.

Definition at line 1422 of file flow_graph.h.

                      {
        if(internal::is_graph_active(this->my_graph)) {
            internal::spawn_in_graph_arena(this->my_graph, *create_put_task());
        }
    }

reset_node()

template<typename JP , typename InputTuple , typename OutputTuple >

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

inlineprotectedvirtual

Implements tbb::flow::interface11::graph_node.

Definition at line 1469 of file flow_graph.h.

      :
    typedef Input input_type;
    typedef Output output_type;
    typedef internal::function_input<input_type,output_type,Policy,internals_allocator> input_impl_type;

try_get()

template<typename JP , typename InputTuple , typename OutputTuple >

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

inlinevirtual

Request an item from the sender.

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

Definition at line 1428 of file flow_graph.h.

                                {
        output_type v;
        if ( !try_reserve_apply_body(v) )

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 1477 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 1311 of file flow_graph.h.

Member Data Documentation

forwarder_busy

template<typename JP , typename InputTuple , typename OutputTuple >

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

private

Definition at line 1312 of file flow_graph.h.

my_aggregator

template<typename JP , typename InputTuple , typename OutputTuple >

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

private

Definition at line 1313 of file flow_graph.h.

my_graph

template<typename JP , typename InputTuple , typename OutputTuple >

graph& tbb::flow::interface11::graph_node::my_graph

protected

Definition at line 464 of file _flow_graph_impl.h.

my_successors

template<typename JP , typename InputTuple , typename OutputTuple >

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

private

Definition at line 1475 of file flow_graph.h.

---

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

• flow_graph.h