Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface11::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::interface11::continue_node< Output, Policy >:
Collaboration diagram for tbb::flow::interface11::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 internal::continue_input< Output, internal::Policy< void > >
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, internal::Policy< void > > class_type
 
- Public Types inherited from 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::interface11::internal::untyped_sender
typedef untyped_receiver successor_type
 The successor type for this node. More...
 

Public Member Functions

template<typename Body >
__TBB_NOINLINE_SYM continue_node (graph &g,)
 Constructor for executable node with continue_msg -> Output. More...
 
template<typename Body >
__TBB_NOINLINE_SYM continue_node (graph &g, int number_of_predecessors,)
 Constructor for executable node with continue_msg -> Output. More...
 
__TBB_NOINLINE_SYM continue_node (const continue_node &src)
 Copy constructor. More...
 
- Public Member Functions inherited from tbb::flow::interface11::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from internal::continue_input< Output, internal::Policy< void > >
 continue_input (graph &g, __TBB_FLOW_GRAPH_PRIORITY_ARG1(Body &body, node_priority_t priority))
 
 continue_input (graph &g, int number_of_predecessors,)
 
 continue_input (const continue_input &src)
 
 ~continue_input ()
 
Body copy_function_object ()
 
void reset_receiver (reset_flags f) __TBB_override
 
- Public Member Functions inherited from internal::function_output< Output >
 function_output (graph &g)
 
 function_output (const function_output &other)
 
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 ()
 
graph & graph_reference () const
 
- Public Member Functions inherited from tbb::flow::interface11::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::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

internal::broadcast_cache< output_type > & successors () __TBB_override
 
void reset_node (reset_flags f) __TBB_override
 
- Protected Member Functions inherited from internal::continue_input< Output, internal::Policy< void > >
taskapply_body_bypass (input_type)
 Applies the body to the provided input. More...
 
taskexecute () __TBB_override
 
graph & graph_reference () const __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::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::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...
 

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

- Public Attributes inherited from tbb::flow::interface11::sender< Output >
__TBB_DEPRECATED typedef Output output_type
 The output type of this sender. More...
 
__TBB_DEPRECATED typedef internal::async_helpers< Output >::filtered_type filtered_type
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 
- Protected Attributes inherited from internal::continue_input< Output, internal::Policy< void > >
graph & my_graph_ref
 
function_body_typemy_body
 
function_body_typemy_init_body
 
- Protected Attributes inherited from internal::function_output< Output >
broadcast_cache_type my_successors
 
graph & my_graph_ref
 

Detailed Description

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

Implements an executable node that supports continue_msg -> Output.

Definition at line 1781 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::interface11::continue_node< Output, Policy >::fOutput_type

Definition at line 1787 of file flow_graph.h.

◆ input_impl_type

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

Definition at line 1786 of file flow_graph.h.

◆ input_type

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

Definition at line 1784 of file flow_graph.h.

◆ output_type

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

Definition at line 1785 of file flow_graph.h.

◆ predecessor_type

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

Definition at line 1788 of file flow_graph.h.

◆ successor_type

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

Definition at line 1789 of file flow_graph.h.

Constructor & Destructor Documentation

◆ continue_node() [1/3]

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

Constructor for executable node with continue_msg -> Output.

Definition at line 1793 of file flow_graph.h.

1800  : graph_node(g), input_impl_type( g, __TBB_FLOW_GRAPH_PRIORITY_ARG1(body, priority) ),
1801  fOutput_type(g) {
1802  tbb::internal::fgt_node_with_body( CODEPTR(), tbb::internal::FLOW_CONTINUE_NODE, &this->my_graph,
1803 
1804  static_cast<receiver<input_type> *>(this),
1805  static_cast<sender<output_type> *>(this), this->my_body );
1806  }
#define __TBB_FLOW_GRAPH_PRIORITY_ARG1(arg1, priority)
#define CODEPTR()
static void fgt_node_with_body(void *, string_index, void *, void *, void *)
internal::continue_input< Output, Policy > input_impl_type
Definition: flow_graph.h:1786
internal::function_output< output_type > fOutput_type
Definition: flow_graph.h:1787

References CODEPTR, tbb::internal::fgt_node_with_body(), internal::continue_input< Output, internal::Policy< void > >::my_body, and tbb::flow::interface11::graph_node::my_graph.

Here is the call graph for this function:

◆ continue_node() [2/3]

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

Constructor for executable node with continue_msg -> Output.

Definition at line 1830 of file flow_graph.h.

1837  : graph_node(g)
1838  , input_impl_type(g, number_of_predecessors, __TBB_FLOW_GRAPH_PRIORITY_ARG1(body, priority)),
1839  fOutput_type(g) {
1840  tbb::internal::fgt_node_with_body( CODEPTR(), tbb::internal::FLOW_CONTINUE_NODE, &this->my_graph,
1841  static_cast<receiver<input_type> *>(this),
1842  static_cast<sender<output_type> *>(this), this->my_body );
1843  }

References CODEPTR, tbb::internal::fgt_node_with_body(), internal::continue_input< Output, internal::Policy< void > >::my_body, and tbb::flow::interface11::graph_node::my_graph.

Here is the call graph for this function:

◆ continue_node() [3/3]

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

Copy constructor.

Definition at line 1868 of file flow_graph.h.

1868  :
1869  graph_node(src.my_graph), input_impl_type(src),
1870  internal::function_output<Output>(src.my_graph) {
1871  tbb::internal::fgt_node_with_body( CODEPTR(), tbb::internal::FLOW_CONTINUE_NODE, &this->my_graph,
1872  static_cast<receiver<input_type> *>(this),
1873  static_cast<sender<output_type> *>(this), this->my_body );
1874  }
Implements methods for both executable and function nodes that puts Output to its successors.

References CODEPTR, tbb::internal::fgt_node_with_body(), internal::continue_input< Output, internal::Policy< void > >::my_body, and tbb::flow::interface11::graph_node::my_graph.

Here is the call graph for this function:

Member Function Documentation

◆ reset_node()

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

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

Definition at line 1896 of file flow_graph.h.

1896  {
1898  if(f & rf_clear_edges)successors().clear();
1899  __TBB_ASSERT(!(f & rf_clear_edges) || successors().empty(), "continue_node not reset");
1900  }
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
internal::broadcast_cache< output_type > & successors() __TBB_override
Definition: flow_graph.h:1894
void reset_receiver(reset_flags f) __TBB_override

References __TBB_ASSERT, internal::successor_cache< T, M >::clear(), internal::successor_cache< T, spin_rw_mutex >::empty(), internal::continue_input< Output, Policy >::reset_receiver(), tbb::flow::interface11::rf_clear_edges, and tbb::flow::interface11::continue_node< Output, Policy >::successors().

Here is the call graph for this function:

◆ successors()

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

Implements internal::continue_input< Output, internal::Policy< void > >.

Definition at line 1894 of file flow_graph.h.

1894 { return fOutput_type::my_successors; }
broadcast_cache_type my_successors

References internal::function_output< Output >::my_successors.

Referenced by tbb::flow::interface11::continue_node< Output, Policy >::reset_node().

Here is the caller graph for this function:

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 1891 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 1892 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 1890 of file flow_graph.h.


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

Copyright © 2005-2020 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.