Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface11::source_node< Output > Class Template Reference

An executable node that acts as a source, i.e. it has no predecessors. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::source_node< Output >:
Collaboration diagram for tbb::flow::interface11::source_node< Output >:

Public Types

typedef Output output_type
 The type of the output message, which is complete. More...
 
typedef sender< output_type >::successor_type successor_type
 The type of successors of this node. More...
 
typedef null_type input_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 source_node (graph &g, Body body, bool is_active=true)
 Constructor for a node with a successor. More...
 
__TBB_NOINLINE_SYM source_node (const source_node &src)
 Copy constructor. More...
 
 ~source_node ()
 The destructor. More...
 
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 node. More...
 
bool try_reserve (output_type &v) __TBB_override
 Reserves an item. More...
 
bool try_release () __TBB_override
 Release a reserved item. More...
 
bool try_consume () __TBB_override
 Consumes a reserved item. More...
 
void activate ()
 Activates a node that was created in the inactive state. More...
 
template<typename Body >
Body copy_function_object ()
 
- 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::internal::untyped_sender
virtual ~untyped_sender ()
 

Protected Member Functions

void reset_node (reset_flags f) __TBB_override
 resets the source_node to its initial state More...
 
- 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...
 

Private Member Functions

bool try_reserve_apply_body (output_type &v)
 
taskcreate_put_task ()
 
void spawn_put ()
 Spawns a task that applies the body. More...
 
taskapply_body_bypass ()
 Applies the body. Returning SUCCESSFULLY_ENQUEUED okay; forward_task_bypass will handle it. More...
 

Private Attributes

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_typemy_successors
 
bool my_reserved
 
bool my_has_cached_item
 
output_type my_cached_item
 

Friends

class internal::source_task_bypass< source_node< output_type > >
 

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
 

Detailed Description

template<typename Output>
class tbb::flow::interface11::source_node< Output >

An executable node that acts as a source, i.e. it has no predecessors.

Definition at line 894 of file flow_graph.h.

Member Typedef Documentation

◆ input_type

template<typename Output >
typedef null_type tbb::flow::interface11::source_node< Output >::input_type

Definition at line 903 of file flow_graph.h.

◆ output_type

template<typename Output >
typedef Output tbb::flow::interface11::source_node< Output >::output_type

The type of the output message, which is complete.

Definition at line 897 of file flow_graph.h.

◆ successor_type

template<typename Output >
typedef sender<output_type>::successor_type tbb::flow::interface11::source_node< Output >::successor_type

The type of successors of this node.

Definition at line 900 of file flow_graph.h.

Constructor & Destructor Documentation

◆ source_node() [1/2]

template<typename Output >
template<typename Body >
__TBB_NOINLINE_SYM tbb::flow::interface11::source_node< Output >::source_node ( graph g,
Body  body,
bool  is_active = true 
)
inline

Constructor for a node with a successor.

Definition at line 912 of file flow_graph.h.

913  : graph_node(g), my_active(is_active), init_my_active(is_active),
916  my_reserved(false), my_has_cached_item(false)
917  {
918  my_successors.set_owner(this);
919  tbb::internal::fgt_node_with_body( CODEPTR(), tbb::internal::FLOW_SOURCE_NODE, &this->my_graph,
920  static_cast<sender<output_type> *>(this), this->my_body );
921  }
The leaf for source_body.
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1096
static void fgt_node_with_body(void *, string_index, void *, void *, void *)
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1095
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1097
#define CODEPTR()

◆ source_node() [2/2]

template<typename Output >
__TBB_NOINLINE_SYM tbb::flow::interface11::source_node< Output >::source_node ( const source_node< Output > &  src)
inline

Copy constructor.

Definition at line 932 of file flow_graph.h.

932  :
933  graph_node(src.my_graph), sender<Output>(),
934  my_active(src.init_my_active),
935  init_my_active(src.init_my_active), my_body( src.my_init_body->clone() ), my_init_body(src.my_init_body->clone() ),
936  my_reserved(false), my_has_cached_item(false)
937  {
938  my_successors.set_owner(this);
939  tbb::internal::fgt_node_with_body(CODEPTR(), tbb::internal::FLOW_SOURCE_NODE, &this->my_graph,
940  static_cast<sender<output_type> *>(this), this->my_body );
941  }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1096
static void fgt_node_with_body(void *, string_index, void *, void *, void *)
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1095
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1097
#define CODEPTR()

◆ ~source_node()

template<typename Output >
tbb::flow::interface11::source_node< Output >::~source_node ( )
inline

The destructor.

Definition at line 944 of file flow_graph.h.

944 { delete my_body; delete my_init_body; }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1096
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1095

Member Function Documentation

◆ activate()

template<typename Output >
void tbb::flow::interface11::source_node< Output >::activate ( )
inline

Activates a node that was created in the inactive state.

Definition at line 1050 of file flow_graph.h.

1050  {
1052  my_active = true;
1053  if (!my_successors.empty())
1054  spawn_put();
1055  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1135
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1097

◆ apply_body_bypass()

template<typename Output >
task* tbb::flow::interface11::source_node< Output >::apply_body_bypass ( )
inlineprivate

Applies the body. Returning SUCCESSFULLY_ENQUEUED okay; forward_task_bypass will handle it.

Definition at line 1143 of file flow_graph.h.

References tbb::flow::interface11::internal::untyped_sender::try_consume(), tbb::flow::interface11::internal::broadcast_cache< T, M >::try_put_task(), and tbb::flow::interface11::internal::untyped_sender::try_release().

1143  {
1144  output_type v;
1145  if ( !try_reserve_apply_body(v) )
1146  return NULL;
1147 
1148  task *last_task = my_successors.try_put_task(v);
1149  if ( last_task )
1150  try_consume();
1151  else
1152  try_release();
1153  return last_task;
1154  }
bool try_consume() __TBB_override
Consumes a reserved item.
Definition: flow_graph.h:1038
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task * task
bool try_reserve_apply_body(output_type &v)
Definition: flow_graph.h:1103
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1097
bool try_release() __TBB_override
Release a reserved item.
Definition: flow_graph.h:1028
Output output_type
The type of the output message, which is complete.
Definition: flow_graph.h:897
Here is the call graph for this function:

◆ copy_function_object()

template<typename Output >
template<typename Body >
Body tbb::flow::interface11::source_node< Output >::copy_function_object ( )
inline

Definition at line 1058 of file flow_graph.h.

1058  {
1059  internal::source_body<output_type> &body_ref = *this->my_body;
1060  return dynamic_cast< internal::source_body_leaf<output_type, Body> & >(body_ref).get_body();
1061  }
The leaf for source_body.
A functor that takes no input and generates a value of type Output.
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1095

◆ create_put_task()

template<typename Output >
task* tbb::flow::interface11::source_node< Output >::create_put_task ( )
inlineprivate

Definition at line 1129 of file flow_graph.h.

1129  {
1130  return ( new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
1131  internal:: source_task_bypass < source_node< output_type > >( *this ) );
1132  }
A task that calls a node&#39;s apply_body_bypass function with no input.
tbb::task * root_task()
Returns the root task of the graph.

◆ register_successor()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::register_successor ( successor_type r)
inlinevirtual

Add a new successor to this node.

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

Definition at line 953 of file flow_graph.h.

References lock.

953  {
956  if ( my_active )
957  spawn_put();
958  return true;
959  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1135
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1097

◆ remove_successor()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::remove_successor ( successor_type r)
inlinevirtual

Removes a successor from this node.

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

Definition at line 962 of file flow_graph.h.

References lock, tbb::flow::interface11::internal::function_output< Output >::my_successors, and tbb::flow::interface11::internal::successor_cache< T, M >::remove_successor().

962  {
965  return true;
966  }
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1097
Here is the call graph for this function:

◆ reset_node()

template<typename Output >
void tbb::flow::interface11::source_node< Output >::reset_node ( reset_flags  f)
inlineprotectedvirtual

resets the source_node to its initial state

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

Definition at line 1075 of file flow_graph.h.

1075  {
1077  my_reserved =false;
1078  if(my_has_cached_item) {
1079  my_has_cached_item = false;
1080  }
1082  if(f & rf_reset_bodies) {
1084  delete my_body;
1085  my_body = tmp;
1086  }
1087  if(my_active)
1089  }
void add_task_to_graph_reset_list(tbb::flow::interface10::graph &g, tbb::task *tp)
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1096
A functor that takes no input and generates a value of type Output.
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1095
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1097

◆ spawn_put()

template<typename Output >
void tbb::flow::interface11::source_node< Output >::spawn_put ( )
inlineprivate

Spawns a task that applies the body.

Definition at line 1135 of file flow_graph.h.

References tbb::flow::interface11::internal::is_graph_active(), and tbb::flow::interface11::internal::spawn_in_graph_arena().

1135  {
1136  if(internal::is_graph_active(this->my_graph)) {
1138  }
1139  }
bool is_graph_active(tbb::flow::interface10::graph &g)
void spawn_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.
Here is the call graph for this function:

◆ try_consume()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_consume ( )
inlinevirtual

Consumes a reserved item.

Reimplemented from tbb::flow::interface11::internal::untyped_sender.

Definition at line 1038 of file flow_graph.h.

References __TBB_ASSERT, tbb::flow::interface11::internal::successor_cache< T, M >::empty(), lock, and tbb::flow::interface11::internal::function_output< Output >::my_successors.

1038  {
1040  __TBB_ASSERT( my_reserved && my_has_cached_item, "consuming non-existent reservation" );
1041  my_reserved = false;
1042  my_has_cached_item = false;
1043  if ( !my_successors.empty() ) {
1044  spawn_put();
1045  }
1046  return true;
1047  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1135
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1097
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
Here is the call graph for this function:

◆ try_get()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_get ( output_type v)
inlinevirtual

Request an item from the node.

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

Definition at line 994 of file flow_graph.h.

References lock.

994  {
996  if ( my_reserved )
997  return false;
998 
999  if ( my_has_cached_item ) {
1000  v = my_cached_item;
1001  my_has_cached_item = false;
1002  return true;
1003  }
1004  // we've been asked to provide an item, but we have none. enqueue a task to
1005  // provide one.
1006  spawn_put();
1007  return false;
1008  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1135
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179

◆ try_release()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_release ( )
inlinevirtual

Release a reserved item.

true = item has been released and so remains in sender, dest must request or reserve future items

Reimplemented from tbb::flow::interface11::internal::untyped_sender.

Definition at line 1028 of file flow_graph.h.

1028  {
1030  __TBB_ASSERT( my_reserved && my_has_cached_item, "releasing non-existent reservation" );
1031  my_reserved = false;
1032  if(!my_successors.empty())
1033  spawn_put();
1034  return true;
1035  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1135
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1097
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165

◆ try_reserve()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_reserve ( output_type v)
inlinevirtual

Reserves an item.

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

Definition at line 1011 of file flow_graph.h.

References lock.

1011  {
1013  if ( my_reserved ) {
1014  return false;
1015  }
1016 
1017  if ( my_has_cached_item ) {
1018  v = my_cached_item;
1019  my_reserved = true;
1020  return true;
1021  } else {
1022  return false;
1023  }
1024  }
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void * lock
friend class scoped_lock
Definition: spin_mutex.h:179

◆ try_reserve_apply_body()

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::try_reserve_apply_body ( output_type v)
inlineprivate

Definition at line 1103 of file flow_graph.h.

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

1103  {
1105  if ( my_reserved ) {
1106  return false;
1107  }
1108  if ( !my_has_cached_item ) {
1110  bool r = (*my_body)(my_cached_item);
1112  if (r) {
1113  my_has_cached_item = true;
1114  }
1115  }
1116  if ( my_has_cached_item ) {
1117  v = my_cached_item;
1118  my_reserved = true;
1119  return true;
1120  } else {
1121  return false;
1122  }
1123  }
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void * lock
static void fgt_end_body(void *)
friend class scoped_lock
Definition: spin_mutex.h:179
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1095
static void fgt_begin_body(void *)
Here is the call graph for this function:

Friends And Related Function Documentation

◆ internal::source_task_bypass< source_node< output_type > >

template<typename Output >
friend class internal::source_task_bypass< source_node< output_type > >
friend

Definition at line 1141 of file flow_graph.h.

Member Data Documentation

◆ init_my_active

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::init_my_active
private

Definition at line 1094 of file flow_graph.h.

◆ my_active

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::my_active
private

Definition at line 1093 of file flow_graph.h.

◆ my_body

template<typename Output >
internal::source_body<output_type>* tbb::flow::interface11::source_node< Output >::my_body
private

Definition at line 1095 of file flow_graph.h.

◆ my_cached_item

template<typename Output >
output_type tbb::flow::interface11::source_node< Output >::my_cached_item
private

Definition at line 1100 of file flow_graph.h.

◆ my_has_cached_item

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::my_has_cached_item
private

Definition at line 1099 of file flow_graph.h.

◆ my_init_body

template<typename Output >
internal::source_body<output_type>* tbb::flow::interface11::source_node< Output >::my_init_body
private

Definition at line 1096 of file flow_graph.h.

◆ my_mutex

template<typename Output >
spin_mutex tbb::flow::interface11::source_node< Output >::my_mutex
private

Definition at line 1092 of file flow_graph.h.

◆ my_reserved

template<typename Output >
bool tbb::flow::interface11::source_node< Output >::my_reserved
private

Definition at line 1098 of file flow_graph.h.

◆ my_successors

template<typename Output >
internal::broadcast_cache< output_type > tbb::flow::interface11::source_node< Output >::my_successors
private

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