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

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

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::broadcast_node< T >:
Collaboration diagram for tbb::flow::interface11::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 Member Functions

__TBB_NOINLINE_SYM broadcast_node (graph &g)
 
__TBB_NOINLINE_SYM 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::interface11::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from tbb::flow::interface11::receiver< T >
virtual ~receiver ()
 Destructor. More...
 
bool try_put (const T &t)
 Put an item to the receiver. More...
 
virtual __TBB_DEPRECATED bool register_predecessor (predecessor_type &)
 Add a predecessor to the node. More...
 
virtual __TBB_DEPRECATED bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node. More...
 
- Public Member Functions inherited from tbb::flow::interface11::sender< T >
virtual ~sender ()
 
virtual __TBB_DEPRECATED bool register_successor (successor_type &r)=0
 Add a new successor to this node. More...
 
virtual __TBB_DEPRECATED bool remove_successor (successor_type &r)=0
 Removes a successor from this node. More...
 
virtual bool try_get (T &)
 Request an item from the sender. More...
 
virtual bool try_reserve (T &)
 Reserves an item in the sender. More...
 
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 () const __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::interface11::receiver< T >
virtual bool is_continue_receiver ()
 

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

- Public Attributes inherited from tbb::flow::interface11::receiver< T >
__TBB_DEPRECATED typedef T input_type
 The input type of this receiver. More...
 
__TBB_DEPRECATED typedef sender< T > predecessor_type
 The predecessor type for this node. More...
 
- Public Attributes inherited from tbb::flow::interface11::sender< T >
__TBB_DEPRECATED typedef T output_type
 The output type of this sender. More...
 
__TBB_DEPRECATED typedef receiver< T > successor_type
 The successor type for this node. More...
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 

Detailed Description

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

Forwards messages of type T to all successors.

Definition at line 1897 of file flow_graph.h.

Member Typedef Documentation

◆ input_type

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

Definition at line 1899 of file flow_graph.h.

◆ output_type

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

Definition at line 1900 of file flow_graph.h.

◆ predecessor_type

Definition at line 1901 of file flow_graph.h.

◆ successor_type

Definition at line 1902 of file flow_graph.h.

Constructor & Destructor Documentation

◆ broadcast_node() [1/2]

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

Definition at line 1915 of file flow_graph.h.

1915  : graph_node(g) {
1916  my_successors.set_owner( this );
1917  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_BROADCAST_NODE, &this->my_graph,
1918  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
1919  }

References CODEPTR, tbb::internal::fgt_node(), tbb::flow::interface11::graph_node::my_graph, and tbb::flow::interface11::broadcast_node< T >::my_successors.

Here is the call graph for this function:

◆ broadcast_node() [2/2]

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

Definition at line 1929 of file flow_graph.h.

1929  :
1930  graph_node(src.my_graph), receiver<T>(), sender<T>()
1931  {
1932  my_successors.set_owner( this );
1933  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_BROADCAST_NODE, &this->my_graph,
1934  static_cast<receiver<input_type> *>(this), static_cast<sender<output_type> *>(this) );
1935  }

References CODEPTR, tbb::internal::fgt_node(), tbb::flow::interface11::graph_node::my_graph, and tbb::flow::interface11::broadcast_node< T >::my_successors.

Here is the call graph for this function:

Member Function Documentation

◆ graph_reference()

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

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

Definition at line 2017 of file flow_graph.h.

2017  {
2018  return my_graph;
2019  }

References tbb::flow::interface11::graph_node::my_graph.

◆ register_successor()

template<typename T >
bool tbb::flow::interface11::broadcast_node< T >::register_successor ( successor_type r)
inline

Adds a successor.

Definition at line 1944 of file flow_graph.h.

1944  {
1945  my_successors.register_successor( r );
1946  return true;
1947  }

References tbb::flow::interface11::broadcast_node< T >::my_successors.

◆ remove_successor()

template<typename T >
bool tbb::flow::interface11::broadcast_node< T >::remove_successor ( successor_type r)
inline

Removes s as a successor.

Definition at line 1950 of file flow_graph.h.

1950  {
1951  my_successors.remove_successor( r );
1952  return true;
1953  }

References tbb::flow::interface11::broadcast_node< T >::my_successors.

◆ reset_node()

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

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

Definition at line 2023 of file flow_graph.h.

2023  {
2024  if (f&rf_clear_edges) {
2025  my_successors.clear();
2026 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
2027  my_built_predecessors.clear();
2028 #endif
2029  }
2030  __TBB_ASSERT(!(f & rf_clear_edges) || my_successors.empty(), "Error resetting broadcast_node");
2031  }

References __TBB_ASSERT, tbb::flow::interface11::broadcast_node< T >::my_successors, and tbb::flow::interface11::rf_clear_edges.

◆ reset_receiver()

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

put receiver back in initial state

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

Definition at line 2021 of file flow_graph.h.

2021 {}

◆ try_put_task()

template<typename T >
task* tbb::flow::interface11::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::interface11::receiver< T >.

Definition at line 2011 of file flow_graph.h.

2011  {
2012  task *new_task = my_successors.try_put_task(t);
2013  if (!new_task) new_task = SUCCESSFULLY_ENQUEUED;
2014  return new_task;
2015  }

References tbb::flow::interface11::broadcast_node< T >::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 2008 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 2009 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 2007 of file flow_graph.h.

Member Data Documentation

◆ my_successors


The documentation for this class was generated from the following file:
CODEPTR
#define CODEPTR()
Definition: _flow_graph_trace_impl.h:297
__TBB_ASSERT
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
tbb::flow::interface11::graph_node::my_graph
graph & my_graph
Definition: _flow_graph_impl.h:464
tbb::flow::internal::SUCCESSFULLY_ENQUEUED
static tbb::task *const SUCCESSFULLY_ENQUEUED
Definition: _flow_graph_impl.h:61
tbb::flow::interface11::broadcast_node::my_successors
internal::broadcast_cache< input_type > my_successors
Definition: flow_graph.h:1908
task
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
Definition: ittnotify_static.h:119
tbb::flow::interface11::graph_node::graph_node
graph_node(graph &g)
Definition: flow_graph.h:887
tbb::flow::interface11::rf_clear_edges
@ rf_clear_edges
Definition: _flow_graph_impl.h:161
tbb::internal::fgt_node
static void fgt_node(void *, string_index, void *, void *)
Definition: _flow_graph_trace_impl.h:326

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.