Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface10::broadcast_node< T > Class Template Reference

Forwards messages of type T to all successors. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::broadcast_node< T >:
Collaboration diagram for tbb::flow::interface10::broadcast_node< T >:

Public Types

typedef T input_type
 
typedef T output_type
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef sender< output_type >::successor_type successor_type
 
- Public Types inherited from tbb::flow::interface10::receiver< T >
typedef T input_type
 The input type of this receiver. More...
 
typedef internal::async_helpers< T >::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::sender< T >
typedef T output_type
 The output type of this sender. More...
 
typedef internal::async_helpers< T >::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

 broadcast_node (graph &g)
 
 broadcast_node (const broadcast_node &src)
 
bool register_successor (successor_type &r) __TBB_override
 Adds a successor. More...
 
bool remove_successor (successor_type &r) __TBB_override
 Removes s as a successor. 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::receiver< T >
bool try_put (const typename internal::async_helpers< T >::filtered_type &t)
 Put an item to the receiver. More...
 
bool try_put (const typename internal::async_helpers< T >::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...
 
virtual bool register_predecessor (predecessor_type &)
 Add a predecessor to the node. More...
 
virtual bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node. More...
 
- Public Member Functions inherited from tbb::flow::interface10::sender< T >
virtual bool try_get (T &)
 Request an item from the sender. More...
 
virtual bool try_reserve (T &)
 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

tasktry_put_task (const T &t) __TBB_override
 build a task to run the successor if possible. Default is old behavior. More...
 
graphgraph_reference () __TBB_override
 
void reset_receiver (reset_flags) __TBB_override
 put receiver back in initial state More...
 
void reset_node (reset_flags f) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::receiver< T >
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)
 
virtual bool is_continue_receiver ()
 
- Protected Member Functions inherited from tbb::flow::interface10::sender< T >
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 Attributes

internal::broadcast_cache< input_typemy_successors
 

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
 

Detailed Description

template<typename T>
class tbb::flow::interface10::broadcast_node< T >

Forwards messages of type T to all successors.

Definition at line 1409 of file flow_graph.h.

Member Typedef Documentation

◆ input_type

template<typename T >
typedef T tbb::flow::interface10::broadcast_node< T >::input_type

Definition at line 1411 of file flow_graph.h.

◆ output_type

template<typename T >
typedef T tbb::flow::interface10::broadcast_node< T >::output_type

Definition at line 1412 of file flow_graph.h.

◆ predecessor_type

Definition at line 1413 of file flow_graph.h.

◆ successor_type

Definition at line 1414 of file flow_graph.h.

Constructor & Destructor Documentation

◆ broadcast_node() [1/2]

template<typename T >
tbb::flow::interface10::broadcast_node< T >::broadcast_node ( graph g)
inlineexplicit

Definition at line 1427 of file flow_graph.h.

1427  : graph_node(g) {
1428  my_successors.set_owner( this );
1429  tbb::internal::fgt_node( tbb::internal::FLOW_BROADCAST_NODE, &this->my_graph,
1430  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
1431  }
static void fgt_node(string_index, void *, void *)
internal::broadcast_cache< input_type > my_successors
Definition: flow_graph.h:1420

References tbb::internal::fgt_node(), and tbb::flow::interface10::internal::successor_cache< T, M >::set_owner().

Here is the call graph for this function:

◆ broadcast_node() [2/2]

template<typename T >
tbb::flow::interface10::broadcast_node< T >::broadcast_node ( const broadcast_node< T > &  src)
inline

Definition at line 1434 of file flow_graph.h.

1434  :
1435  graph_node(src.my_graph), receiver<T>(), sender<T>()
1436  {
1437  my_successors.set_owner( this );
1438  tbb::internal::fgt_node( tbb::internal::FLOW_BROADCAST_NODE, &this->my_graph,
1439  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
1440  }
static void fgt_node(string_index, void *, void *)
internal::broadcast_cache< input_type > my_successors
Definition: flow_graph.h:1420

References tbb::internal::fgt_node(), and tbb::flow::interface10::internal::successor_cache< T, M >::set_owner().

Here is the call graph for this function:

Member Function Documentation

◆ graph_reference()

template<typename T >
graph& tbb::flow::interface10::broadcast_node< T >::graph_reference ( )
inlineprotectedvirtual

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

Definition at line 1522 of file flow_graph.h.

1522  {
1523  return my_graph;
1524  }

◆ register_successor()

template<typename T >
bool tbb::flow::interface10::broadcast_node< T >::register_successor ( successor_type r)
inlinevirtual

Adds a successor.

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

Definition at line 1449 of file flow_graph.h.

1449  {
1451  return true;
1452  }
internal::broadcast_cache< input_type > my_successors
Definition: flow_graph.h:1420

References tbb::flow::interface10::internal::successor_cache< T, M >::register_successor().

Here is the call graph for this function:

◆ remove_successor()

template<typename T >
bool tbb::flow::interface10::broadcast_node< T >::remove_successor ( successor_type r)
inlinevirtual

Removes s as a successor.

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

Definition at line 1455 of file flow_graph.h.

1455  {
1457  return true;
1458  }
internal::broadcast_cache< input_type > my_successors
Definition: flow_graph.h:1420

References tbb::flow::interface10::internal::successor_cache< T, M >::remove_successor().

Here is the call graph for this function:

◆ reset_node()

template<typename T >
void tbb::flow::interface10::broadcast_node< T >::reset_node ( reset_flags  f)
inlineprotectedvirtual

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

Definition at line 1528 of file flow_graph.h.

1528  {
1529  if (f&rf_clear_edges) {
1530  my_successors.clear();
1531 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
1532  my_built_predecessors.clear();
1533 #endif
1534  }
1535  __TBB_ASSERT(!(f & rf_clear_edges) || my_successors.empty(), "Error resetting broadcast_node");
1536  }
internal::broadcast_cache< input_type > my_successors
Definition: flow_graph.h:1420
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165

References internal::successor_cache< T, M >::my_successors, and tbb::flow::interface10::rf_clear_edges.

◆ reset_receiver()

template<typename T >
void tbb::flow::interface10::broadcast_node< T >::reset_receiver ( reset_flags  f)
inlineprotectedvirtual

put receiver back in initial state

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

Definition at line 1526 of file flow_graph.h.

1526 {}

◆ try_put_task()

template<typename T >
task* tbb::flow::interface10::broadcast_node< T >::try_put_task ( const T &  t)
inlineprotectedvirtual

build a task to run the successor if possible. Default is old behavior.

Implements tbb::flow::interface10::receiver< T >.

Definition at line 1516 of file flow_graph.h.

1516  {
1517  task *new_task = my_successors.try_put_task(t);
1518  if (!new_task) new_task = SUCCESSFULLY_ENQUEUED;
1519  return new_task;
1520  }
static tbb::task *const SUCCESSFULLY_ENQUEUED
internal::broadcast_cache< input_type > my_successors
Definition: flow_graph.h:1420
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

References internal::successor_cache< T, M >::my_successors, and tbb::flow::internal::SUCCESSFULLY_ENQUEUED.

Friends And Related Function Documentation

◆ internal::broadcast_cache

template<typename T >
template<typename X , typename Y >
friend class internal::broadcast_cache
friend

Definition at line 1513 of file flow_graph.h.

◆ internal::round_robin_cache

template<typename T >
template<typename X , typename Y >
friend class internal::round_robin_cache
friend

Definition at line 1514 of file flow_graph.h.

◆ run_and_put_task

template<typename T >
template<typename R , typename B >
friend class run_and_put_task
friend

Definition at line 1512 of file flow_graph.h.

Member Data Documentation

◆ my_successors

template<typename T >
internal::broadcast_cache<input_type> tbb::flow::interface10::broadcast_node< T >::my_successors
private

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