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

Forwards messages only if the threshold has not been reached. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::limiter_node< T, DecrementType >:
Collaboration diagram for tbb::flow::interface11::limiter_node< T, DecrementType >:

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::interface11::internal::untyped_receiver
typedef untyped_sender predecessor_type
 The predecessor type for this node. More...
 
- 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

 limiter_node (graph &g, __TBB_DEPRECATED_LIMITER_ARG2(size_t threshold, int num_decrement_predecessors=0))
 Constructor. More...
 
 limiter_node (const limiter_node &src)
 Copy constructor. More...
 
bool register_successor (successor_type &r) __TBB_override
 Replace the current successor with this new successor. More...
 
bool remove_successor (successor_type &r) __TBB_override
 Removes a successor from this node. More...
 
bool register_predecessor (predecessor_type &src) __TBB_override
 Adds src to the list of cached predecessors. More...
 
bool remove_predecessor (predecessor_type &src) __TBB_override
 Removes src from the list of cached predecessors. 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 >
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::interface11::internal::untyped_receiver
virtual ~untyped_receiver ()
 Destructor. More...
 
template<typename X >
bool try_put (const X &t)
 Put an item to the receiver. More...
 
- Public Member Functions inherited from tbb::flow::interface11::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::interface11::internal::untyped_sender
virtual ~untyped_sender ()
 
virtual bool try_release ()
 Releases the reserved item. More...
 
virtual bool try_consume ()
 Consumes the reserved item. More...
 

Public Attributes

internal::decrementer< limiter_node< T, DecrementType >, DecrementType > decrement
 The internal receiver< DecrementType > that decrements the count. More...
 
- 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 internal::async_helpers< T >::filtered_type filtered_type
 
- 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 internal::async_helpers< T >::filtered_type filtered_type
 

Protected Member Functions

tasktry_put_task (const T &t) __TBB_override
 Puts an item to this receiver. 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 tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
virtual bool is_continue_receiver ()
 
- Protected Member Functions inherited from tbb::flow::interface11::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::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 check_conditions ()
 
taskforward_task ()
 
void forward ()
 
taskdecrement_counter (long long delta)
 
void initialize ()
 

Private Attributes

size_t my_threshold
 
size_t my_count
 
size_t my_tries
 
internal::reservable_predecessor_cache< T, spin_mutexmy_predecessors
 
spin_mutex my_mutex
 
internal::broadcast_cache< T > my_successors
 

Friends

class internal::forward_task_bypass< limiter_node< T, DecrementType > >
 
class internal::decrementer< limiter_node< T, DecrementType >, DecrementType >
 
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::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 

Detailed Description

template<typename T, typename DecrementType = continue_msg>
class tbb::flow::interface11::limiter_node< T, DecrementType >

Forwards messages only if the threshold has not been reached.

This node forwards items until its threshold is reached. It contains no buffering. If the downstream node rejects, the message is dropped.

Definition at line 113 of file flow_graph.h.

Member Typedef Documentation

◆ input_type

template<typename T , typename DecrementType = continue_msg>
typedef T tbb::flow::interface11::limiter_node< T, DecrementType >::input_type

Definition at line 2602 of file flow_graph.h.

◆ output_type

template<typename T , typename DecrementType = continue_msg>
typedef T tbb::flow::interface11::limiter_node< T, DecrementType >::output_type

Definition at line 2603 of file flow_graph.h.

◆ predecessor_type

template<typename T , typename DecrementType = continue_msg>
typedef receiver<input_type>::predecessor_type tbb::flow::interface11::limiter_node< T, DecrementType >::predecessor_type

Definition at line 2604 of file flow_graph.h.

◆ successor_type

template<typename T , typename DecrementType = continue_msg>
typedef sender<output_type>::successor_type tbb::flow::interface11::limiter_node< T, DecrementType >::successor_type

Definition at line 2605 of file flow_graph.h.

Constructor & Destructor Documentation

◆ limiter_node() [1/2]

template<typename T , typename DecrementType = continue_msg>
tbb::flow::interface11::limiter_node< T, DecrementType >::limiter_node ( graph g,
__TBB_DEPRECATED_LIMITER_ARG2(size_t threshold, int num_decrement_predecessors=0)   
)
inline

Constructor.

Definition at line 2725 of file flow_graph.h.

2727  : graph_node(g), my_threshold(threshold), my_count(0),
2729  my_tries(0), decrement(),
2730  init_decrement_predecessors(num_decrement_predecessors),
2731  decrement(num_decrement_predecessors)) {
2732  initialize();
2733  }
internal::decrementer< limiter_node< T, DecrementType >, DecrementType > decrement
The internal receiver< DecrementType > that decrements the count.
Definition: flow_graph.h:2716
#define __TBB_DEPRECATED_LIMITER_ARG4(arg1, arg2, arg3, arg4)

References tbb::flow::interface11::limiter_node< T, DecrementType >::initialize().

Here is the call graph for this function:

◆ limiter_node() [2/2]

template<typename T , typename DecrementType = continue_msg>
tbb::flow::interface11::limiter_node< T, DecrementType >::limiter_node ( const limiter_node< T, DecrementType > &  src)
inline

Copy constructor.

Definition at line 2744 of file flow_graph.h.

2744  :
2745  graph_node(src.my_graph), receiver<T>(), sender<T>(),
2746  my_threshold(src.my_threshold), my_count(0),
2748  my_tries(0), decrement(),
2749  init_decrement_predecessors(src.init_decrement_predecessors),
2750  decrement(src.init_decrement_predecessors)) {
2751  initialize();
2752  }
internal::decrementer< limiter_node< T, DecrementType >, DecrementType > decrement
The internal receiver< DecrementType > that decrements the count.
Definition: flow_graph.h:2716
#define __TBB_DEPRECATED_LIMITER_ARG4(arg1, arg2, arg3, arg4)

References tbb::flow::interface11::limiter_node< T, DecrementType >::initialize().

Here is the call graph for this function:

Member Function Documentation

◆ check_conditions()

template<typename T , typename DecrementType = continue_msg>
bool tbb::flow::interface11::limiter_node< T, DecrementType >::check_conditions ( )
inlineprivate

Definition at line 2628 of file flow_graph.h.

2628  { // always called under lock
2629  return ( my_count + my_tries < my_threshold && !my_predecessors.empty() && !my_successors.empty() );
2630  }
internal::reservable_predecessor_cache< T, spin_mutex > my_predecessors
Definition: flow_graph.h:2618
internal::broadcast_cache< T > my_successors
Definition: flow_graph.h:2620

References tbb::flow::interface11::internal::successor_cache< T, M >::empty(), tbb::flow::interface11::limiter_node< T, DecrementType >::my_count, tbb::flow::interface11::limiter_node< T, DecrementType >::my_predecessors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_successors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_threshold, and tbb::flow::interface11::limiter_node< T, DecrementType >::my_tries.

Referenced by tbb::flow::interface11::limiter_node< T, DecrementType >::forward_task(), and tbb::flow::interface11::limiter_node< T, DecrementType >::try_put_task().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ decrement_counter()

template<typename T , typename DecrementType = continue_msg>
task* tbb::flow::interface11::limiter_node< T, DecrementType >::decrement_counter ( long long  delta)
inlineprivate

Definition at line 2691 of file flow_graph.h.

2691  {
2692  {
2694  if( delta > 0 && size_t(delta) > my_count )
2695  my_count = 0;
2696  else if( delta < 0 && size_t(delta) > my_threshold - my_count )
2698  else
2699  my_count -= size_t(delta); // absolute value of delta is sufficiently small
2700  }
2701  return forward_task();
2702  }
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

References tbb::flow::interface11::limiter_node< T, DecrementType >::forward_task(), lock, tbb::flow::interface11::limiter_node< T, DecrementType >::my_count, tbb::flow::interface11::limiter_node< T, DecrementType >::my_mutex, and tbb::flow::interface11::limiter_node< T, DecrementType >::my_threshold.

Here is the call graph for this function:

◆ forward()

template<typename T , typename DecrementType = continue_msg>
void tbb::flow::interface11::limiter_node< T, DecrementType >::forward ( )
inlineprivate

Definition at line 2686 of file flow_graph.h.

2686  {
2687  __TBB_ASSERT(false, "Should never be called");
2688  return;
2689  }
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165

References __TBB_ASSERT.

◆ forward_task()

template<typename T , typename DecrementType = continue_msg>
task* tbb::flow::interface11::limiter_node< T, DecrementType >::forward_task ( )
inlineprivate

Definition at line 2633 of file flow_graph.h.

2633  {
2634  input_type v;
2635  task *rval = NULL;
2636  bool reserved = false;
2637  {
2639  if ( check_conditions() )
2640  ++my_tries;
2641  else
2642  return NULL;
2643  }
2644 
2645  //SUCCESS
2646  // if we can reserve and can put, we consume the reservation
2647  // we increment the count and decrement the tries
2648  if ( (my_predecessors.try_reserve(v)) == true ){
2649  reserved=true;
2650  if ( (rval = my_successors.try_put_task(v)) != NULL ){
2651  {
2653  ++my_count;
2654  --my_tries;
2655  my_predecessors.try_consume();
2656  if ( check_conditions() ) {
2657  if ( internal::is_graph_active(this->my_graph) ) {
2658  task *rtask = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
2659  internal::forward_task_bypass< limiter_node<T, DecrementType> >( *this );
2661  }
2662  }
2663  }
2664  return rval;
2665  }
2666  }
2667  //FAILURE
2668  //if we can't reserve, we decrement the tries
2669  //if we can reserve but can't put, we decrement the tries and release the reservation
2670  {
2672  --my_tries;
2673  if (reserved) my_predecessors.try_release();
2674  if ( check_conditions() ) {
2675  if ( internal::is_graph_active(this->my_graph) ) {
2676  task *rtask = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
2677  internal::forward_task_bypass< limiter_node<T, DecrementType> >( *this );
2678  __TBB_ASSERT(!rval, "Have two tasks to handle");
2679  return rtask;
2680  }
2681  }
2682  return rval;
2683  }
2684  }
internal::reservable_predecessor_cache< T, spin_mutex > my_predecessors
Definition: flow_graph.h:2618
bool is_graph_active(tbb::flow::interface10::graph &g)
internal::broadcast_cache< T > my_successors
Definition: flow_graph.h:2620
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 task that calls a node's forward_task function.
tbb::task * root_task()
Returns the root task of the graph.
graph & graph_reference() const __TBB_override
Definition: flow_graph.h:2875
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
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
void spawn_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.

References __TBB_ASSERT, tbb::flow::interface11::limiter_node< T, DecrementType >::check_conditions(), tbb::flow::interface11::limiter_node< T, DecrementType >::graph_reference(), tbb::flow::interface11::internal::is_graph_active(), lock, tbb::flow::interface11::limiter_node< T, DecrementType >::my_count, tbb::flow::interface11::graph_node::my_graph, tbb::flow::interface11::limiter_node< T, DecrementType >::my_mutex, tbb::flow::interface11::limiter_node< T, DecrementType >::my_predecessors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_successors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_tries, tbb::flow::interface10::graph::root_task(), tbb::flow::interface11::internal::spawn_in_graph_arena(), and tbb::flow::interface11::internal::broadcast_cache< T, M >::try_put_task().

Referenced by tbb::flow::interface11::limiter_node< T, DecrementType >::decrement_counter().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ graph_reference()

template<typename T , typename DecrementType = continue_msg>
graph& tbb::flow::interface11::limiter_node< T, DecrementType >::graph_reference ( ) const
inlineprotectedvirtual

◆ initialize()

template<typename T , typename DecrementType = continue_msg>
void tbb::flow::interface11::limiter_node< T, DecrementType >::initialize ( )
inlineprivate

Definition at line 2704 of file flow_graph.h.

2704  {
2705  my_predecessors.set_owner(this);
2706  my_successors.set_owner(this);
2707  decrement.set_owner(this);
2709  CODEPTR(), tbb::internal::FLOW_LIMITER_NODE, &this->my_graph,
2710  static_cast<receiver<input_type> *>(this), static_cast<receiver<DecrementType> *>(&decrement),
2711  static_cast<sender<output_type> *>(this)
2712  );
2713  }
internal::decrementer< limiter_node< T, DecrementType >, DecrementType > decrement
The internal receiver< DecrementType > that decrements the count.
Definition: flow_graph.h:2716
#define CODEPTR()
internal::reservable_predecessor_cache< T, spin_mutex > my_predecessors
Definition: flow_graph.h:2618
internal::broadcast_cache< T > my_successors
Definition: flow_graph.h:2620
static void fgt_node(void *, string_index, void *, void *)

References CODEPTR, tbb::flow::interface11::limiter_node< T, DecrementType >::decrement, tbb::internal::fgt_node(), tbb::flow::interface11::graph_node::my_graph, tbb::flow::interface11::limiter_node< T, DecrementType >::my_predecessors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_successors, and tbb::flow::interface11::internal::successor_cache< T, M >::set_owner().

Referenced by tbb::flow::interface11::limiter_node< T, DecrementType >::limiter_node().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ register_predecessor()

template<typename T , typename DecrementType = continue_msg>
bool tbb::flow::interface11::limiter_node< T, DecrementType >::register_predecessor ( predecessor_type src)
inlinevirtual

Adds src to the list of cached predecessors.

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

Definition at line 2825 of file flow_graph.h.

2825  {
2827  my_predecessors.add( src );
2829  task* task = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
2830  internal::forward_task_bypass < limiter_node<T, DecrementType> >( *this );
2832  }
2833  return true;
2834  }
internal::reservable_predecessor_cache< T, spin_mutex > my_predecessors
Definition: flow_graph.h:2618
bool is_graph_active(tbb::flow::interface10::graph &g)
internal::broadcast_cache< T > my_successors
Definition: flow_graph.h:2620
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 task that calls a node's forward_task function.
tbb::task * root_task()
Returns the root task of the graph.
graph & graph_reference() const __TBB_override
Definition: flow_graph.h:2875
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
void spawn_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.

References tbb::flow::interface11::internal::successor_cache< T, M >::empty(), tbb::flow::interface11::limiter_node< T, DecrementType >::graph_reference(), tbb::flow::interface11::internal::is_graph_active(), lock, tbb::flow::interface11::limiter_node< T, DecrementType >::my_count, tbb::flow::interface11::graph_node::my_graph, tbb::flow::interface11::limiter_node< T, DecrementType >::my_mutex, tbb::flow::interface11::limiter_node< T, DecrementType >::my_predecessors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_successors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_threshold, tbb::flow::interface11::limiter_node< T, DecrementType >::my_tries, tbb::flow::interface10::graph::root_task(), and tbb::flow::interface11::internal::spawn_in_graph_arena().

Here is the call graph for this function:

◆ register_successor()

template<typename T , typename DecrementType = continue_msg>
bool tbb::flow::interface11::limiter_node< T, DecrementType >::register_successor ( successor_type r)
inlinevirtual

Replace the current successor with this new successor.

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

Definition at line 2761 of file flow_graph.h.

2761  {
2763  bool was_empty = my_successors.empty();
2765  //spawn a forward task if this is the only successor
2766  if ( was_empty && !my_predecessors.empty() && my_count + my_tries < my_threshold ) {
2767  if ( internal::is_graph_active(this->my_graph) ) {
2768  task* task = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
2769  internal::forward_task_bypass < limiter_node<T, DecrementType> >( *this );
2771  }
2772  }
2773  return true;
2774  }
internal::reservable_predecessor_cache< T, spin_mutex > my_predecessors
Definition: flow_graph.h:2618
bool is_graph_active(tbb::flow::interface10::graph &g)
internal::broadcast_cache< T > my_successors
Definition: flow_graph.h:2620
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 task that calls a node's forward_task function.
tbb::task * root_task()
Returns the root task of the graph.
graph & graph_reference() const __TBB_override
Definition: flow_graph.h:2875
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
void spawn_in_graph_arena(tbb::flow::interface10::graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.

References tbb::flow::interface11::internal::successor_cache< T, M >::empty(), tbb::flow::interface11::limiter_node< T, DecrementType >::graph_reference(), tbb::flow::interface11::internal::is_graph_active(), lock, tbb::flow::interface11::limiter_node< T, DecrementType >::my_count, tbb::flow::interface11::graph_node::my_graph, tbb::flow::interface11::limiter_node< T, DecrementType >::my_mutex, tbb::flow::interface11::limiter_node< T, DecrementType >::my_predecessors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_successors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_threshold, tbb::flow::interface11::limiter_node< T, DecrementType >::my_tries, tbb::flow::interface11::internal::successor_cache< T, M >::register_successor(), tbb::flow::interface10::graph::root_task(), and tbb::flow::interface11::internal::spawn_in_graph_arena().

Here is the call graph for this function:

◆ remove_predecessor()

template<typename T , typename DecrementType = continue_msg>
bool tbb::flow::interface11::limiter_node< T, DecrementType >::remove_predecessor ( predecessor_type src)
inlinevirtual

Removes src from the list of cached predecessors.

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

Definition at line 2837 of file flow_graph.h.

2837  {
2838  my_predecessors.remove( src );
2839  return true;
2840  }
internal::reservable_predecessor_cache< T, spin_mutex > my_predecessors
Definition: flow_graph.h:2618

References tbb::flow::interface11::limiter_node< T, DecrementType >::my_predecessors.

◆ remove_successor()

template<typename T , typename DecrementType = continue_msg>
bool tbb::flow::interface11::limiter_node< T, DecrementType >::remove_successor ( successor_type r)
inlinevirtual

Removes a successor from this node.

r.remove_predecessor(*this) is also called.

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

Definition at line 2778 of file flow_graph.h.

2778  {
2779  r.remove_predecessor(*this);
2781  return true;
2782  }
internal::broadcast_cache< T > my_successors
Definition: flow_graph.h:2620

References tbb::flow::interface11::limiter_node< T, DecrementType >::my_successors, and tbb::flow::interface11::internal::successor_cache< T, M >::remove_successor().

Here is the call graph for this function:

◆ reset_node()

template<typename T , typename DecrementType = continue_msg>
void tbb::flow::interface11::limiter_node< T, DecrementType >::reset_node ( reset_flags  f)
inlineprotectedvirtual

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

Definition at line 2881 of file flow_graph.h.

2881  {
2882  my_count = 0;
2883  if(f & rf_clear_edges) {
2884  my_predecessors.clear();
2885  my_successors.clear();
2886  }
2887  else
2888  {
2889  my_predecessors.reset( );
2890  }
2891  decrement.reset_receiver(f);
2892  }
internal::decrementer< limiter_node< T, DecrementType >, DecrementType > decrement
The internal receiver< DecrementType > that decrements the count.
Definition: flow_graph.h:2716
internal::reservable_predecessor_cache< T, spin_mutex > my_predecessors
Definition: flow_graph.h:2618
internal::broadcast_cache< T > my_successors
Definition: flow_graph.h:2620

References tbb::flow::interface11::internal::successor_cache< T, M >::clear(), tbb::flow::interface11::limiter_node< T, DecrementType >::decrement, tbb::flow::interface11::limiter_node< T, DecrementType >::my_count, tbb::flow::interface11::limiter_node< T, DecrementType >::my_predecessors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_successors, and tbb::flow::interface11::rf_clear_edges.

Here is the call graph for this function:

◆ reset_receiver()

template<typename T , typename DecrementType = continue_msg>
void tbb::flow::interface11::limiter_node< T, DecrementType >::reset_receiver ( reset_flags  f)
inlineprotectedvirtual

put receiver back in initial state

Implements tbb::flow::interface11::internal::untyped_receiver.

Definition at line 2877 of file flow_graph.h.

2877  {
2878  __TBB_ASSERT(false,NULL); // should never be called
2879  }
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165

References __TBB_ASSERT.

◆ try_put_task()

template<typename T , typename DecrementType = continue_msg>
task* tbb::flow::interface11::limiter_node< T, DecrementType >::try_put_task ( const T &  t)
inlineprotectedvirtual

Puts an item to this receiver.

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

Definition at line 2848 of file flow_graph.h.

2848  {
2849  {
2851  if ( my_count + my_tries >= my_threshold )
2852  return NULL;
2853  else
2854  ++my_tries;
2855  }
2856 
2857  task * rtask = my_successors.try_put_task(t);
2858 
2859  if ( !rtask ) { // try_put_task failed.
2861  --my_tries;
2863  rtask = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
2864  internal::forward_task_bypass< limiter_node<T, DecrementType> >( *this );
2865  }
2866  }
2867  else {
2869  ++my_count;
2870  --my_tries;
2871  }
2872  return rtask;
2873  }
bool is_graph_active(tbb::flow::interface10::graph &g)
internal::broadcast_cache< T > my_successors
Definition: flow_graph.h:2620
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 task that calls a node's forward_task function.
tbb::task * root_task()
Returns the root task of the graph.
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

References tbb::flow::interface11::limiter_node< T, DecrementType >::check_conditions(), tbb::flow::interface11::internal::is_graph_active(), lock, tbb::flow::interface11::limiter_node< T, DecrementType >::my_count, tbb::flow::interface11::graph_node::my_graph, tbb::flow::interface11::limiter_node< T, DecrementType >::my_mutex, tbb::flow::interface11::limiter_node< T, DecrementType >::my_successors, tbb::flow::interface11::limiter_node< T, DecrementType >::my_threshold, tbb::flow::interface11::limiter_node< T, DecrementType >::my_tries, tbb::flow::interface10::graph::root_task(), and tbb::flow::interface11::internal::broadcast_cache< T, M >::try_put_task().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ internal::broadcast_cache

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

Definition at line 2845 of file flow_graph.h.

◆ internal::decrementer< limiter_node< T, DecrementType >, DecrementType >

template<typename T , typename DecrementType = continue_msg>
friend class internal::decrementer< limiter_node< T, DecrementType >, DecrementType >
friend

Definition at line 2626 of file flow_graph.h.

◆ internal::forward_task_bypass< limiter_node< T, DecrementType > >

template<typename T , typename DecrementType = continue_msg>
friend class internal::forward_task_bypass< limiter_node< T, DecrementType > >
friend

Definition at line 2623 of file flow_graph.h.

◆ internal::round_robin_cache

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

Definition at line 2846 of file flow_graph.h.

◆ run_and_put_task

template<typename T , typename DecrementType = continue_msg>
template<typename R , typename B >
friend class run_and_put_task
friend

Definition at line 2844 of file flow_graph.h.

Member Data Documentation

◆ decrement

template<typename T , typename DecrementType = continue_msg>
internal::decrementer< limiter_node<T, DecrementType>, DecrementType > tbb::flow::interface11::limiter_node< T, DecrementType >::decrement

◆ my_count

◆ my_mutex

◆ my_predecessors

◆ my_successors

◆ my_threshold

◆ my_tries


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.