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

A cache of successors that are broadcast to. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::internal::broadcast_cache< T, M >:
Collaboration diagram for tbb::flow::interface10::internal::broadcast_cache< T, M >:

Public Member Functions

 broadcast_cache ()
 
template<typename X >
tasktry_put_task (const X &t)
 
template<typename X >
bool gather_successful_try_puts (const X &t, task_list &tasks)
 
- Public Member Functions inherited from tbb::flow::interface10::internal::successor_cache< T, M >
 successor_cache ()
 
void set_owner (owner_type *owner)
 
virtual ~successor_cache ()
 
void register_successor (successor_type &r)
 
void remove_successor (successor_type &r)
 
bool empty ()
 
void clear ()
 

Private Types

typedef M mutex_type
 
typedef successor_cache< T, M >::successors_type successors_type
 

Additional Inherited Members

- Protected Types inherited from tbb::flow::interface10::internal::successor_cache< T, M >
typedef M mutex_type
 
typedef untyped_receiver successor_type
 
typedef untyped_receiverpointer_type
 
typedef untyped_sender owner_type
 
typedef std::list< pointer_typesuccessors_type
 
- Protected Attributes inherited from tbb::flow::interface10::internal::successor_cache< T, M >
mutex_type my_mutex
 
successors_type my_successors
 
owner_typemy_owner
 

Detailed Description

template<typename T, typename M = spin_rw_mutex>
class tbb::flow::interface10::internal::broadcast_cache< T, M >

A cache of successors that are broadcast to.

Definition at line 108 of file flow_graph.h.

Member Typedef Documentation

◆ mutex_type

template<typename T, typename M = spin_rw_mutex>
typedef M tbb::flow::interface10::internal::broadcast_cache< T, M >::mutex_type
private

Definition at line 467 of file flow_graph.h.

◆ successors_type

template<typename T, typename M = spin_rw_mutex>
typedef successor_cache<T,M>::successors_type tbb::flow::interface10::internal::broadcast_cache< T, M >::successors_type
private

Definition at line 468 of file flow_graph.h.

Constructor & Destructor Documentation

◆ broadcast_cache()

template<typename T, typename M = spin_rw_mutex>
tbb::flow::interface10::internal::broadcast_cache< T, M >::broadcast_cache ( )
inline

Definition at line 472 of file flow_graph.h.

474 {}

Member Function Documentation

◆ gather_successful_try_puts()

template<typename T, typename M = spin_rw_mutex>
template<typename X >
bool tbb::flow::interface10::internal::broadcast_cache< T, M >::gather_successful_try_puts ( const X &  t,
task_list tasks 
)
inline

Definition at line 511 of file flow_graph.h.

Referenced by tbb::flow::interface10::async_node< Input, Output, Policy, Allocator >::try_put_impl().

511  :
513  typedef T input_type;
514 
516  typedef sender<T> predecessor_type;
517 
519  virtual ~receiver() {}
520 
522  bool try_put( const T& t ) {
523  task *res = try_put_task(t);
524  if (!res) return false;
525  if (res != SUCCESSFULLY_ENQUEUED) internal::spawn_in_graph_arena(graph_reference(), *res);
526  return true;
527  }
528 
530 protected:
531  template< typename R, typename B > friend class run_and_put_task;
532  template< typename X, typename Y > friend class internal::broadcast_cache;
533  template< typename X, typename Y > friend class internal::round_robin_cache;
534  virtual task *try_put_task(const T& t) = 0;
535  virtual graph& graph_reference() = 0;
536 public:
537  // NOTE: Following part of PUBLIC and PROTECTED sections is copy-pasted in receiver<T> under #if __TBB_PREVIEW_ASYNC_MSG
538 
540  virtual bool register_predecessor( predecessor_type & ) { return false; }
541 
void spawn_in_graph_arena(graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.
A cache of successors that are broadcast to.
static tbb::task *const SUCCESSFULLY_ENQUEUED
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
A cache of successors that are put in a round-robin fashion.
Here is the caller graph for this function:

◆ try_put_task()

template<typename T, typename M = spin_rw_mutex>
template<typename X >
task* tbb::flow::interface10::internal::broadcast_cache< T, M >::try_put_task ( const X &  t)
inline

Definition at line 477 of file flow_graph.h.

Referenced by tbb::flow::interface10::source_node< Output >::apply_body_bypass(), tbb::flow::interface11::limiter_node< T, DecrementType >::forward_task(), tbb::flow::interface10::broadcast_node< T >::try_put_task(), tbb::flow::interface11::limiter_node< T, DecrementType >::try_put_task(), and tbb::flow::interface10a::overwrite_node< T >::try_put_task_impl().

485  { return false; }
486 
488  virtual bool try_reserve( T & ) { return false; }
489 
491  virtual bool try_release( ) { return false; }
492 
494  virtual bool try_consume( ) { return false; }
495 
496 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
497  typedef typename internal::edge_container<successor_type> built_successors_type;
499  typedef typename built_successors_type::edge_list_type successor_list_type;
500  virtual built_successors_type &built_successors() = 0;
501  virtual void internal_add_built_successor( successor_type & ) = 0;
502  virtual void internal_delete_built_successor( successor_type & ) = 0;
503  virtual void copy_successors( successor_list_type &) = 0;
504  virtual size_t successor_count() = 0;
505 #endif /* TBB_DEPRECATED_FLOW_NODE_EXTRACTION */
506 }; // class sender<T>
Here is the caller graph for this function:

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.