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

Implements methods for an executable node that takes continue_msg as input. More...

#include <flow_graph.h>

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

Public Types

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 Member Functions

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...
 

Protected Member Functions

virtual broadcast_cache< output_type > & successors ()=0
 
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 Attributes

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
 

Friends

class apply_body_task_bypass< class_type, continue_msg >
 

Detailed Description

template<typename Output, typename Policy>
class tbb::flow::interface10::internal::continue_input< Output, Policy >

Implements methods for an executable node that takes continue_msg as input.

Definition at line 678 of file flow_graph.h.

Member Typedef Documentation

◆ class_type

template<typename Output , typename Policy >
typedef continue_input<output_type, Policy> tbb::flow::interface10::internal::continue_input< Output, Policy >::class_type

Definition at line 687 of file flow_graph.h.

◆ function_body_type

template<typename Output , typename Policy >
typedef function_body<input_type, output_type> tbb::flow::interface10::internal::continue_input< Output, Policy >::function_body_type

Definition at line 686 of file flow_graph.h.

◆ input_type

template<typename Output , typename Policy >
typedef continue_msg tbb::flow::interface10::internal::continue_input< Output, Policy >::input_type

The input type of this receiver.

Definition at line 682 of file flow_graph.h.

◆ output_type

template<typename Output , typename Policy >
typedef Output tbb::flow::interface10::internal::continue_input< Output, Policy >::output_type

The output type of this receiver.

Definition at line 685 of file flow_graph.h.

Constructor & Destructor Documentation

◆ continue_input() [1/3]

template<typename Output , typename Policy >
template<typename Body >
tbb::flow::interface10::internal::continue_input< Output, Policy >::continue_input ( graph g,
__TBB_FLOW_GRAPH_PRIORITY_ARG1(Body &body, node_priority_t priority)   
)
inline

Definition at line 690 of file flow_graph.h.

693  {
694  return t.key();
695  }

◆ continue_input() [2/3]

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

Definition at line 698 of file flow_graph.h.

707  {

◆ continue_input() [3/3]

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

Definition at line 706 of file flow_graph.h.

707  {
708 namespace flow {
709 namespace interface10 {

◆ ~continue_input()

template<typename Output , typename Policy >
tbb::flow::interface10::internal::continue_input< Output, Policy >::~continue_input ( )
inline

Definition at line 711 of file flow_graph.h.

Member Function Documentation

◆ apply_body_bypass()

template<typename Output , typename Policy >
task* tbb::flow::interface10::internal::continue_input< Output, Policy >::apply_body_bypass ( input_type  )
inlineprotected

Applies the body to the provided input.

Definition at line 742 of file flow_graph.h.

743  : my_nodes(NULL), my_nodes_last(NULL), my_task_arena(NULL) {
744  prepare_task_arena();
745  own_context = true;
746  cancelled = false;
747  caught_exception = false;
748  my_context = new task_group_context(tbb::internal::FLOW_TASKS);
749  my_root_task = (new (task::allocate_root(*my_context)) empty_task);
static internal::allocate_root_proxy allocate_root()
Returns proxy for overloaded new that allocates a root task.
Definition: task.h:633

◆ copy_function_object()

template<typename Output , typename Policy >
template<typename Body >
Body tbb::flow::interface10::internal::continue_input< Output, Policy >::copy_function_object ( )
inline

Definition at line 717 of file flow_graph.h.

720  : my_graph(g), current_node(NULL)

◆ execute()

template<typename Output , typename Policy >
task* tbb::flow::interface10::internal::continue_input< Output, Policy >::execute ( )
inlineprotectedvirtual

Does whatever should happen when the threshold is reached.

This should be very fast or else spawn a task. This is called while the sender is blocked in the try_put().

Implements tbb::flow::interface10::continue_receiver.

Definition at line 751 of file flow_graph.h.

755  :
756  my_context(&use_this_context), my_nodes(NULL), my_nodes_last(NULL), my_task_arena(NULL) {
757  prepare_task_arena();
758  own_context = false;
759  my_root_task = (new (task::allocate_root(*my_context)) empty_task);
760  my_root_task->set_ref_count(1);
762  my_is_active = true;
763 }
764 
765 inline graph::~graph() {
766  wait_for_all();
767  my_root_task->set_ref_count(0);
768  tbb::task::destroy(*my_root_task);
769  if (own_context) delete my_context;
770  delete my_task_arena;
~graph()
Destroys the graph.
Definition: flow_graph.h:765
static internal::allocate_root_proxy allocate_root()
Returns proxy for overloaded new that allocates a root task.
Definition: task.h:633
static void fgt_graph(void *)

◆ graph_reference()

template<typename Output , typename Policy >
graph& tbb::flow::interface10::internal::continue_input< Output, Policy >::graph_reference ( )
inlineprotectedvirtual

Implements tbb::flow::interface10::internal::untyped_receiver.

Definition at line 772 of file flow_graph.h.

773  {
774  if (my_root_task) {

◆ reset_receiver()

template<typename Output , typename Policy >
void tbb::flow::interface10::internal::continue_input< Output, Policy >::reset_receiver ( reset_flags  f)
inlinevirtual

put receiver back in initial state

Reimplemented from tbb::flow::interface10::continue_receiver.

Definition at line 722 of file flow_graph.h.

727  {
728  __TBB_ASSERT(current_node, "graph_iterator at end");
729  return *operator->();
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165

◆ successors()

template<typename Output , typename Policy >
virtual broadcast_cache<output_type >& tbb::flow::interface10::internal::continue_input< Output, Policy >::successors ( )
protectedpure virtual

Friends And Related Function Documentation

◆ apply_body_task_bypass< class_type, continue_msg >

template<typename Output , typename Policy >
friend class apply_body_task_bypass< class_type, continue_msg >
friend

Definition at line 739 of file flow_graph.h.

Member Data Documentation

◆ my_body

template<typename Output , typename Policy >
function_body_type* tbb::flow::interface10::internal::continue_input< Output, Policy >::my_body
protected

Definition at line 734 of file flow_graph.h.

◆ my_graph_ref

template<typename Output , typename Policy >
graph& tbb::flow::interface10::internal::continue_input< Output, Policy >::my_graph_ref
protected

Definition at line 733 of file flow_graph.h.

◆ my_init_body

template<typename Output , typename Policy >
function_body_type* tbb::flow::interface10::internal::continue_input< Output, Policy >::my_init_body
protected

Definition at line 735 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.