Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface10::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::interface10::source_node< Output >:
Collaboration diagram for tbb::flow::interface10::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::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 >
 source_node (graph &g, Body body, bool is_active=true)
 Constructor for a node with a successor. More...
 
 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::interface10::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from tbb::flow::interface10::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::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...
 

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

- Protected Attributes inherited from tbb::flow::interface10::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 

Detailed Description

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

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

Definition at line 863 of file flow_graph.h.

Member Typedef Documentation

◆ input_type

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

Definition at line 872 of file flow_graph.h.

◆ output_type

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

The type of the output message, which is complete.

Definition at line 866 of file flow_graph.h.

◆ successor_type

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

The type of successors of this node.

Definition at line 869 of file flow_graph.h.

Constructor & Destructor Documentation

◆ source_node() [1/2]

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

Constructor for a node with a successor.

Definition at line 881 of file flow_graph.h.

882  : graph_node(g), my_active(is_active), init_my_active(is_active),
885  my_reserved(false), my_has_cached_item(false)
886  {
887  my_successors.set_owner(this);
888  tbb::internal::fgt_node_with_body( tbb::internal::FLOW_SOURCE_NODE, &this->my_graph,
889  static_cast<sender<output_type> *>(this), this->my_body );
890  }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1057
static void fgt_node_with_body(string_index, void *, void *, void *)
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1056
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1058
The leaf for source_body.

◆ source_node() [2/2]

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

Copy constructor.

Definition at line 893 of file flow_graph.h.

References tbb::internal::fgt_node_with_body().

893  :
894  graph_node(src.my_graph), sender<Output>(),
895  my_active(src.init_my_active),
896  init_my_active(src.init_my_active), my_body( src.my_init_body->clone() ), my_init_body(src.my_init_body->clone() ),
897  my_reserved(false), my_has_cached_item(false)
898  {
899  my_successors.set_owner(this);
900  tbb::internal::fgt_node_with_body( tbb::internal::FLOW_SOURCE_NODE, &this->my_graph,
901  static_cast<sender<output_type> *>(this), this->my_body );
902  }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1057
static void fgt_node_with_body(string_index, void *, void *, void *)
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1056
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1058
Here is the call graph for this function:

◆ ~source_node()

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

The destructor.

Definition at line 905 of file flow_graph.h.

905 { delete my_body; delete my_init_body; }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1057
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1056

Member Function Documentation

◆ activate()

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

Activates a node that was created in the inactive state.

Definition at line 1011 of file flow_graph.h.

1011  {
1013  my_active = true;
1014  if (!my_successors.empty())
1015  spawn_put();
1016  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1096
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1058
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:176

◆ apply_body_bypass()

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

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

Definition at line 1104 of file flow_graph.h.

References tbb::flow::interface10::internal::broadcast_cache< T, M >::try_put_task().

1104  {
1105  output_type v;
1106  if ( !try_reserve_apply_body(v) )
1107  return NULL;
1108 
1109  task *last_task = my_successors.try_put_task(v);
1110  if ( last_task )
1111  try_consume();
1112  else
1113  try_release();
1114  return last_task;
1115  }
bool try_consume() __TBB_override
Consumes a reserved item.
Definition: flow_graph.h:999
bool try_release() __TBB_override
Release a reserved item.
Definition: flow_graph.h:989
bool try_reserve_apply_body(output_type &v)
Definition: flow_graph.h:1064
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
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1058
Output output_type
The type of the output message, which is complete.
Definition: flow_graph.h:866
Here is the call graph for this function:

◆ copy_function_object()

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

Definition at line 1019 of file flow_graph.h.

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

◆ create_put_task()

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

Definition at line 1090 of file flow_graph.h.

1090  {
1091  return ( new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
1092  internal:: source_task_bypass < source_node< output_type > >( *this ) );
1093  }
tbb::task * root_task()
Returns the root task of the graph.

◆ register_successor()

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

Add a new successor to this node.

Implements tbb::flow::interface10::internal::untyped_sender.

Definition at line 914 of file flow_graph.h.

References lock.

914  {
917  if ( my_active )
918  spawn_put();
919  return true;
920  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1096
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1058
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:176

◆ remove_successor()

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

Removes a successor from this node.

Implements tbb::flow::interface10::internal::untyped_sender.

Definition at line 923 of file flow_graph.h.

923  {
926  return true;
927  }
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1058
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:176

◆ reset_node()

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

resets the source_node to its initial state

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

Definition at line 1036 of file flow_graph.h.

1036  {
1038  my_reserved =false;
1039  if(my_has_cached_item) {
1040  my_has_cached_item = false;
1041  }
1043  if(f & rf_reset_bodies) {
1045  delete my_body;
1046  my_body = tmp;
1047  }
1048  if(my_active)
1050  }
internal::source_body< output_type > * my_init_body
Definition: flow_graph.h:1057
A functor that takes no input and generates a value of type Output.
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1056
void add_task_to_graph_reset_list(graph &g, tbb::task *tp)
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1058

◆ spawn_put()

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

Spawns a task that applies the body.

Definition at line 1096 of file flow_graph.h.

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

1096  {
1097  if(internal::is_graph_active(this->my_graph)) {
1099  }
1100  }
void spawn_in_graph_arena(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::interface10::source_node< Output >::try_consume ( )
inlinevirtual

Consumes a reserved item.

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

Definition at line 999 of file flow_graph.h.

References __TBB_ASSERT, and lock.

999  {
1001  __TBB_ASSERT( my_reserved && my_has_cached_item, "consuming non-existent reservation" );
1002  my_reserved = false;
1003  my_has_cached_item = false;
1004  if ( !my_successors.empty() ) {
1005  spawn_put();
1006  }
1007  return true;
1008  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1096
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1058
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:176

◆ try_get()

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

Request an item from the node.

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

Definition at line 955 of file flow_graph.h.

References lock.

955  {
957  if ( my_reserved )
958  return false;
959 
960  if ( my_has_cached_item ) {
961  v = my_cached_item;
962  my_has_cached_item = false;
963  return true;
964  }
965  // we've been asked to provide an item, but we have none. enqueue a task to
966  // provide one.
967  spawn_put();
968  return false;
969  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1096
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:176

◆ try_release()

template<typename Output >
bool tbb::flow::interface10::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::interface10::internal::untyped_sender.

Definition at line 989 of file flow_graph.h.

References __TBB_ASSERT, and lock.

989  {
991  __TBB_ASSERT( my_reserved && my_has_cached_item, "releasing non-existent reservation" );
992  my_reserved = false;
993  if(!my_successors.empty())
994  spawn_put();
995  return true;
996  }
void spawn_put()
Spawns a task that applies the body.
Definition: flow_graph.h:1096
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
internal::broadcast_cache< output_type > my_successors
Definition: flow_graph.h:1058
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:176

◆ try_reserve()

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

Reserves an item.

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

Definition at line 972 of file flow_graph.h.

References lock.

972  {
974  if ( my_reserved ) {
975  return false;
976  }
977 
978  if ( my_has_cached_item ) {
979  v = my_cached_item;
980  my_reserved = true;
981  return true;
982  } else {
983  return false;
984  }
985  }
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:176

◆ try_reserve_apply_body()

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

Definition at line 1064 of file flow_graph.h.

1064  {
1066  if ( my_reserved ) {
1067  return false;
1068  }
1069  if ( !my_has_cached_item ) {
1071  bool r = (*my_body)(my_cached_item);
1073  if (r) {
1074  my_has_cached_item = true;
1075  }
1076  }
1077  if ( my_has_cached_item ) {
1078  v = my_cached_item;
1079  my_reserved = true;
1080  return true;
1081  } else {
1082  return false;
1083  }
1084  }
static void fgt_end_body(void *)
internal::source_body< output_type > * my_body
Definition: flow_graph.h:1056
static void fgt_begin_body(void *)
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:176

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

Member Data Documentation

◆ init_my_active

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

Definition at line 1055 of file flow_graph.h.

◆ my_active

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

Definition at line 1054 of file flow_graph.h.

◆ my_body

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

Definition at line 1056 of file flow_graph.h.

◆ my_cached_item

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

Definition at line 1061 of file flow_graph.h.

◆ my_has_cached_item

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

Definition at line 1060 of file flow_graph.h.

◆ my_init_body

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

Definition at line 1057 of file flow_graph.h.

◆ my_mutex

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

Definition at line 1053 of file flow_graph.h.

◆ my_reserved

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

Definition at line 1059 of file flow_graph.h.

◆ my_successors

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

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