Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface10::continue_node< Output, Policy > Class Template Reference

Implements an executable node that supports continue_msg -> Output. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::continue_node< Output, Policy >:
Collaboration diagram for tbb::flow::interface10::continue_node< Output, Policy >:

Public Types

typedef continue_msg input_type
 
typedef Output output_type
 
typedef internal::continue_input< Output, Policy > input_impl_type
 
typedef internal::function_output< output_typefOutput_type
 
typedef input_impl_type::predecessor_type predecessor_type
 
typedef fOutput_type::successor_type successor_type
 
- Public Types inherited from tbb::flow::interface10::internal::continue_input< Output, Policy >
typedef continue_msg input_type
 The input type of this receiver. More...
 
typedef Output output_type
 The output type of this receiver. More...
 
typedef function_body< input_type, output_typefunction_body_type
 
typedef continue_input< output_type, Policyclass_type
 
- Public Types inherited from tbb::flow::interface10::continue_receiver
typedef continue_msg input_type
 The input type. More...
 
typedef receiver< input_type >::predecessor_type predecessor_type
 The predecessor type for this node. More...
 
- Public Types inherited from tbb::flow::interface10::receiver< continue_msg >
typedef continue_msg input_type
 The input type of this receiver. More...
 
typedef internal::async_helpers< continue_msg >::filtered_type filtered_type
 
- Public Types inherited from tbb::flow::interface10::internal::untyped_receiver
typedef untyped_sender predecessor_type
 The predecessor type for this node. More...
 
- Public Types inherited from tbb::flow::interface10::internal::function_output< Output >
typedef Output output_type
 
typedef sender< output_type >::successor_type successor_type
 
typedef broadcast_cache< output_typebroadcast_cache_type
 
- Public Types inherited from tbb::flow::interface10::sender< Output >
typedef Output output_type
 The output type of this sender. More...
 
typedef internal::async_helpers< Output >::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

template<typename Body >
 continue_node (graph &g,)
 Constructor for executable node with continue_msg -> Output. More...
 
template<typename Body >
 continue_node (graph &g, int number_of_predecessors,)
 Constructor for executable node with continue_msg -> Output. More...
 
 continue_node (const continue_node &src)
 Copy constructor. 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::internal::continue_input< Output, Policy >
template<typename Body >
 continue_input (graph &g, __TBB_FLOW_GRAPH_PRIORITY_ARG1(Body &body, node_priority_t priority))
 
template<typename Body >
 continue_input (graph &g, int number_of_predecessors,)
 
 continue_input (const continue_input &src)
 
 ~continue_input ()
 
template<typename Body >
Body copy_function_object ()
 
void reset_receiver (reset_flags f) __TBB_override
 put receiver back in initial state More...
 
- Public Member Functions inherited from tbb::flow::interface10::continue_receiver
 continue_receiver (__TBB_FLOW_GRAPH_PRIORITY_ARG1(int number_of_predecessors, node_priority_t priority))
 Constructor. More...
 
 continue_receiver (const continue_receiver &src)
 Copy constructor. More...
 
bool register_predecessor (predecessor_type &) __TBB_override
 Increments the trigger threshold. More...
 
bool remove_predecessor (predecessor_type &) __TBB_override
 Decrements the trigger threshold. More...
 
- Public Member Functions inherited from tbb::flow::interface10::receiver< continue_msg >
bool try_put (const typename internal::async_helpers< continue_msg >::filtered_type &t)
 Put an item to the receiver. More...
 
bool try_put (const typename internal::async_helpers< continue_msg >::async_type &t)
 
- Public Member Functions inherited from tbb::flow::interface10::internal::untyped_receiver
virtual ~untyped_receiver ()
 Destructor. More...
 
template<typename X >
bool try_put (const X &t)
 Put an item to the receiver. More...
 
- Public Member Functions inherited from tbb::flow::interface10::internal::function_output< Output >
 function_output ()
 
 function_output (const function_output &)
 
bool register_successor (successor_type &r) __TBB_override
 Adds a new successor to this node. More...
 
bool remove_successor (successor_type &r) __TBB_override
 Removes a successor from this node. More...
 
tasktry_put_task (const output_type &i)
 
broadcast_cache_typesuccessors ()
 
- Public Member Functions inherited from tbb::flow::interface10::sender< Output >
virtual bool try_get (Output &)
 Request an item from the sender. More...
 
virtual bool try_reserve (Output &)
 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

internal::broadcast_cache< output_type > & successors () __TBB_override
 
void reset_node (reset_flags f) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::internal::continue_input< Output, Policy >
taskapply_body_bypass (input_type)
 Applies the body to the provided input. More...
 
taskexecute () __TBB_override
 Does whatever should happen when the threshold is reached. More...
 
graphgraph_reference () __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::continue_receiver
tasktry_put_task (const input_type &) __TBB_override
 Put item to successor; return task to run the successor if possible. More...
 
bool is_continue_receiver () __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::receiver< continue_msg >
virtual tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
- Protected Member Functions inherited from tbb::flow::interface10::sender< Output >
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...
 

Friends

template<typename R , typename B >
class run_and_put_task
 
template<typename X , typename Y >
class internal::broadcast_cache
 
template<typename X , typename Y >
class internal::round_robin_cache
 

Additional Inherited Members

- Protected Attributes inherited from tbb::flow::interface10::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 
- Protected Attributes inherited from tbb::flow::interface10::internal::continue_input< Output, Policy >
graphmy_graph_ref
 
function_body_typemy_body
 
function_body_typemy_init_body
 
- Protected Attributes inherited from tbb::flow::interface10::continue_receiver
spin_mutex my_mutex
 
int my_predecessor_count
 
int my_current_count
 
int my_initial_predecessor_count
 
- Protected Attributes inherited from tbb::flow::interface10::internal::function_output< Output >
broadcast_cache_type my_successors
 

Detailed Description

template<typename Output, typename Policy = internal::Policy<void>>
class tbb::flow::interface10::continue_node< Output, Policy >

Implements an executable node that supports continue_msg -> Output.

Definition at line 1338 of file flow_graph.h.

Member Typedef Documentation

◆ fOutput_type

template<typename Output , typename Policy = internal::Policy<void>>
typedef internal::function_output<output_type> tbb::flow::interface10::continue_node< Output, Policy >::fOutput_type

Definition at line 1344 of file flow_graph.h.

◆ input_impl_type

template<typename Output , typename Policy = internal::Policy<void>>
typedef internal::continue_input<Output, Policy> tbb::flow::interface10::continue_node< Output, Policy >::input_impl_type

Definition at line 1343 of file flow_graph.h.

◆ input_type

template<typename Output , typename Policy = internal::Policy<void>>
typedef continue_msg tbb::flow::interface10::continue_node< Output, Policy >::input_type

Definition at line 1341 of file flow_graph.h.

◆ output_type

template<typename Output , typename Policy = internal::Policy<void>>
typedef Output tbb::flow::interface10::continue_node< Output, Policy >::output_type

Definition at line 1342 of file flow_graph.h.

◆ predecessor_type

template<typename Output , typename Policy = internal::Policy<void>>
typedef input_impl_type::predecessor_type tbb::flow::interface10::continue_node< Output, Policy >::predecessor_type

Definition at line 1345 of file flow_graph.h.

◆ successor_type

template<typename Output , typename Policy = internal::Policy<void>>
typedef fOutput_type::successor_type tbb::flow::interface10::continue_node< Output, Policy >::successor_type

Definition at line 1346 of file flow_graph.h.

Constructor & Destructor Documentation

◆ continue_node() [1/3]

template<typename Output , typename Policy = internal::Policy<void>>
template<typename Body >
tbb::flow::interface10::continue_node< Output, Policy >::continue_node ( graph g)
inline

Constructor for executable node with continue_msg -> Output.

Definition at line 1350 of file flow_graph.h.

References tbb::internal::fgt_node_with_body().

1353  : graph_node(g), input_impl_type( g, __TBB_FLOW_GRAPH_PRIORITY_ARG1(body, priority) ) {
1354  tbb::internal::fgt_node_with_body( tbb::internal::FLOW_CONTINUE_NODE, &this->my_graph,
1355  static_cast<receiver<input_type> *>(this),
1356  static_cast<sender<output_type> *>(this), this->my_body );
1357  }
static void fgt_node_with_body(string_index, void *, void *, void *)
internal::continue_input< Output, Policy > input_impl_type
Definition: flow_graph.h:1343
#define __TBB_FLOW_GRAPH_PRIORITY_ARG1(arg1, priority)
Here is the call graph for this function:

◆ continue_node() [2/3]

template<typename Output , typename Policy = internal::Policy<void>>
template<typename Body >
tbb::flow::interface10::continue_node< Output, Policy >::continue_node ( graph g,
int  number_of_predecessors 
)
inline

Constructor for executable node with continue_msg -> Output.

Definition at line 1361 of file flow_graph.h.

References tbb::internal::fgt_node_with_body().

1364  : graph_node(g)
1365  , input_impl_type(g, number_of_predecessors, __TBB_FLOW_GRAPH_PRIORITY_ARG1(body, priority)) {
1366  tbb::internal::fgt_node_with_body( tbb::internal::FLOW_CONTINUE_NODE, &this->my_graph,
1367  static_cast<receiver<input_type> *>(this),
1368  static_cast<sender<output_type> *>(this), this->my_body );
1369  }
static void fgt_node_with_body(string_index, void *, void *, void *)
internal::continue_input< Output, Policy > input_impl_type
Definition: flow_graph.h:1343
#define __TBB_FLOW_GRAPH_PRIORITY_ARG1(arg1, priority)
Here is the call graph for this function:

◆ continue_node() [3/3]

template<typename Output , typename Policy = internal::Policy<void>>
tbb::flow::interface10::continue_node< Output, Policy >::continue_node ( const continue_node< Output, Policy > &  src)
inline

Copy constructor.

Definition at line 1372 of file flow_graph.h.

References __TBB_override, tbb::internal::fgt_node_desc(), and tbb::internal::fgt_node_with_body().

1372  :
1373  graph_node(src.my_graph), input_impl_type(src),
1375  tbb::internal::fgt_node_with_body( tbb::internal::FLOW_CONTINUE_NODE, &this->my_graph,
1376  static_cast<receiver<input_type> *>(this),
1377  static_cast<sender<output_type> *>(this), this->my_body );
1378  }
static void fgt_node_with_body(string_index, void *, void *, void *)
internal::continue_input< Output, Policy > input_impl_type
Definition: flow_graph.h:1343
Implements methods for both executable and function nodes that puts Output to its successors...
Here is the call graph for this function:

Member Function Documentation

◆ reset_node()

template<typename Output , typename Policy = internal::Policy<void>>
void tbb::flow::interface10::continue_node< Output, Policy >::reset_node ( reset_flags  f)
inlineprotectedvirtual

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

Definition at line 1400 of file flow_graph.h.

1400  {
1402  if(f & rf_clear_edges)successors().clear();
1403  __TBB_ASSERT(!(f & rf_clear_edges) || successors().empty(), "continue_node not reset");
1404  }
void reset_receiver(reset_flags f) __TBB_override
put receiver back in initial state
Definition: flow_graph.h:722
internal::broadcast_cache< output_type > & successors() __TBB_override
Definition: flow_graph.h:1398
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165

◆ successors()

template<typename Output , typename Policy = internal::Policy<void>>
internal::broadcast_cache<output_type>& tbb::flow::interface10::continue_node< Output, Policy >::successors ( )
inlineprotectedvirtual

Friends And Related Function Documentation

◆ internal::broadcast_cache

template<typename Output , typename Policy = internal::Policy<void>>
template<typename X , typename Y >
friend class internal::broadcast_cache
friend

Definition at line 1395 of file flow_graph.h.

◆ internal::round_robin_cache

template<typename Output , typename Policy = internal::Policy<void>>
template<typename X , typename Y >
friend class internal::round_robin_cache
friend

Definition at line 1396 of file flow_graph.h.

◆ run_and_put_task

template<typename Output , typename Policy = internal::Policy<void>>
template<typename R , typename B >
friend class run_and_put_task
friend

Definition at line 1394 of file flow_graph.h.


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

Copyright © 2005-2019 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.