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

#include <flow_graph.h>

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

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

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
task *	try_put_task (const T &t) __TBB_override
	Puts an item to this receiver. More...

graph &	graph_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 task *	try_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 >
task *	try_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 ()

task *	forward_task ()

void	forward ()

task *	decrement_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_mutex >	my_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
graph &	my_graph

graph_node *	next

graph_node *	prev

Detailed Description

template<typename T, typename U>
class tbb::flow::interface11::limiter_node< T, U >

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

Member Typedef Documentation

template<typename T , typename U >

typedef T tbb::flow::interface11::limiter_node< T, U >::input_type

Definition at line 2979 of file flow_graph.h.

template<typename T , typename U >

typedef T tbb::flow::interface11::limiter_node< T, U >::output_type

Definition at line 2980 of file flow_graph.h.

template<typename T , typename U >

typedef receiver<input_type>::predecessor_type tbb::flow::interface11::limiter_node< T, U >::predecessor_type

Definition at line 2981 of file flow_graph.h.

template<typename T , typename U >

typedef sender<output_type>::successor_type tbb::flow::interface11::limiter_node< T, U >::successor_type

Definition at line 2982 of file flow_graph.h.

Constructor & Destructor Documentation

template<typename T , typename U >

tbb::flow::interface11::limiter_node< T, U >::limiter_node	(	graph &	g,
		__TBB_DEPRECATED_LIMITER_ARG2(size_t threshold, int num_decrement_predecessors=0)
	)

inline

Constructor.

Definition at line 3102 of file flow_graph.h.

         : graph_node(g), my_threshold(threshold), my_count(0),
           __TBB_DEPRECATED_LIMITER_ARG4(
               my_tries(0), decrement(),
               init_decrement_predecessors(num_decrement_predecessors),
               decrement(num_decrement_predecessors)) {
         initialize();
     }

template<typename T , typename U >

tbb::flow::interface11::limiter_node< T, U >::limiter_node ( const limiter_node< T, U > & src )

inline

Copy constructor.

Definition at line 3121 of file flow_graph.h.

                                             :
         graph_node(src.my_graph), receiver<T>(), sender<T>(),
         my_threshold(src.my_threshold), my_count(0),
         __TBB_DEPRECATED_LIMITER_ARG4(
             my_tries(0), decrement(),
             init_decrement_predecessors(src.init_decrement_predecessors),
             decrement(src.init_decrement_predecessors)) {
         initialize();
     }

Member Function Documentation

template<typename T , typename U >

bool tbb::flow::interface11::limiter_node< T, U >::check_conditions ( )

inlineprivate

Definition at line 3005 of file flow_graph.h.

References tbb::flow::interface11::internal::successor_cache< T, M >::empty().

                             {  // always called under lock
         return ( my_count + my_tries < my_threshold && !my_predecessors.empty() && !my_successors.empty() );
     }

Here is the call graph for this function:

template<typename T , typename U >

task* tbb::flow::interface11::limiter_node< T, U >::decrement_counter ( long long delta )

inlineprivate

Definition at line 3068 of file flow_graph.h.

References tbb::lock().

                                                {
         {
             spin_mutex::scoped_lock lock(my_mutex);
             if( delta > 0 && size_t(delta) > my_count )
                 my_count = 0;
             else if( delta < 0 && size_t(delta) > my_threshold - my_count )
                 my_count = my_threshold;
             else
                 my_count -= size_t(delta); // absolute value of delta is sufficiently small
         }
         return forward_task();
     }

Here is the call graph for this function:

template<typename T , typename U >

void tbb::flow::interface11::limiter_node< T, U >::forward ( )

inlineprivate

Definition at line 3063 of file flow_graph.h.

References __TBB_ASSERT.

                    {
         __TBB_ASSERT(false, "Should never be called");
         return;
     }

template<typename T , typename U >

task* tbb::flow::interface11::limiter_node< T, U >::forward_task ( )

inlineprivate

Definition at line 3010 of file flow_graph.h.

References __TBB_ASSERT, tbb::flow::interface11::internal::is_graph_active(), tbb::lock(), tbb::flow::interface11::internal::spawn_in_graph_arena(), and tbb::flow::interface11::internal::broadcast_cache< T, M >::try_put_task().

                          {
         input_type v;
         task *rval = NULL;
         bool reserved = false;
             {
                 spin_mutex::scoped_lock lock(my_mutex);
                 if ( check_conditions() )
                     ++my_tries;
                 else
                     return NULL;
             }
 
         //SUCCESS
         // if we can reserve and can put, we consume the reservation
         // we increment the count and decrement the tries
         if ( (my_predecessors.try_reserve(v)) == true ){
             reserved=true;
             if ( (rval = my_successors.try_put_task(v)) != NULL ){
                 {
                     spin_mutex::scoped_lock lock(my_mutex);
                     ++my_count;
                     --my_tries;
                     my_predecessors.try_consume();
                     if ( check_conditions() ) {
                         if ( internal::is_graph_active(this->my_graph) ) {
                             task *rtask = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
                                 internal::forward_task_bypass< limiter_node<T, DecrementType> >( *this );
                             internal::spawn_in_graph_arena(graph_reference(), *rtask);
                         }
                     }
                 }
                 return rval;
             }
         }
         //FAILURE
         //if we can't reserve, we decrement the tries
         //if we can reserve but can't put, we decrement the tries and release the reservation
         {
             spin_mutex::scoped_lock lock(my_mutex);
             --my_tries;
             if (reserved) my_predecessors.try_release();
             if ( check_conditions() ) {
                 if ( internal::is_graph_active(this->my_graph) ) {
                     task *rtask = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
                         internal::forward_task_bypass< limiter_node<T, DecrementType> >( *this );
                     __TBB_ASSERT(!rval, "Have two tasks to handle");
                     return rtask;
                 }
             }
             return rval;
         }
     }

Here is the call graph for this function:

template<typename T , typename U >

graph& tbb::flow::interface11::limiter_node< T, U >::graph_reference ( ) const

inlineprotectedvirtual

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

Definition at line 3252 of file flow_graph.h.

3252 { return my_graph; }

tbb::flow::interface11::graph_node::my_graph

graph & my_graph

Definition: _flow_graph_impl.h:464

template<typename T , typename U >

void tbb::flow::interface11::limiter_node< T, U >::initialize ( )

inlineprivate

Definition at line 3081 of file flow_graph.h.

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

                       {
         my_predecessors.set_owner(this);
         my_successors.set_owner(this);
         decrement.set_owner(this);
         tbb::internal::fgt_node(
             CODEPTR(), tbb::internal::FLOW_LIMITER_NODE, &this->my_graph,
             static_cast<receiver<input_type> *>(this), static_cast<receiver<DecrementType> *>(&decrement),
             static_cast<sender<output_type> *>(this)
         );
     }

Here is the call graph for this function:

template<typename T , typename U >

bool tbb::flow::interface11::limiter_node< T, U >::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 3202 of file flow_graph.h.

References tbb::flow::interface11::internal::successor_cache< T, M >::empty(), tbb::flow::interface11::internal::is_graph_active(), tbb::lock(), and tbb::flow::interface11::internal::spawn_in_graph_arena().

                                                                       {
         spin_mutex::scoped_lock lock(my_mutex);
         my_predecessors.add( src );
         if ( my_count + my_tries < my_threshold && !my_successors.empty() && internal::is_graph_active(this->my_graph) ) {
             task* task = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
                 internal::forward_task_bypass < limiter_node<T, DecrementType> >( *this );
             internal::spawn_in_graph_arena(graph_reference(), *task);
         }
         return true;
     }

Here is the call graph for this function:

template<typename T , typename U >

bool tbb::flow::interface11::limiter_node< T, U >::register_successor ( successor_type & r )

inlinevirtual

Replace the current successor with this new successor.

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

Definition at line 3138 of file flow_graph.h.

References tbb::flow::interface11::internal::successor_cache< T, M >::empty(), tbb::flow::interface11::internal::is_graph_active(), tbb::lock(), tbb::flow::interface11::internal::successor_cache< T, M >::register_successor(), and tbb::flow::interface11::internal::spawn_in_graph_arena().

                                                                 {
         spin_mutex::scoped_lock lock(my_mutex);
         bool was_empty = my_successors.empty();
         my_successors.register_successor(r);
         //spawn a forward task if this is the only successor
         if ( was_empty && !my_predecessors.empty() && my_count + my_tries < my_threshold ) {
             if ( internal::is_graph_active(this->my_graph) ) {
                 task* task = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
                     internal::forward_task_bypass < limiter_node<T, DecrementType> >( *this );
                 internal::spawn_in_graph_arena(graph_reference(), *task);
             }
         }
         return true;
     }

Here is the call graph for this function:

template<typename T , typename U >

bool tbb::flow::interface11::limiter_node< T, U >::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 3214 of file flow_graph.h.

                                                                     {
         my_predecessors.remove( src );
         return true;
     }

template<typename T , typename U >

bool tbb::flow::interface11::limiter_node< T, U >::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 3155 of file flow_graph.h.

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

                                                               {
         r.remove_predecessor(*this);
         my_successors.remove_successor(r);
         return true;
     }

Here is the call graph for this function:

template<typename T , typename U >

void tbb::flow::interface11::limiter_node< T, U >::reset_node ( reset_flags f )

inlineprotectedvirtual

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

Definition at line 3258 of file flow_graph.h.

References tbb::flow::interface11::internal::successor_cache< T, M >::clear().

                                                    {
         my_count = 0;
         if(f & rf_clear_edges) {
             my_predecessors.clear();
             my_successors.clear();
         }
         else
         {
             my_predecessors.reset( );
         }
         decrement.reset_receiver(f);
     }

Here is the call graph for this function:

template<typename T , typename U >

void tbb::flow::interface11::limiter_node< T, U >::reset_receiver ( reset_flags f )

inlineprotectedvirtual

put receiver back in initial state

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

Definition at line 3254 of file flow_graph.h.

References __TBB_ASSERT.

                                                       {
         __TBB_ASSERT(false,NULL);  // should never be called
     }

template<typename T , typename U >

task* tbb::flow::interface11::limiter_node< T, U >::try_put_task ( const T & t )

inlineprotectedvirtual

Puts an item to this receiver.

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

Definition at line 3225 of file flow_graph.h.

References tbb::flow::interface11::internal::is_graph_active(), tbb::lock(), and tbb::flow::interface11::internal::broadcast_cache< T, M >::try_put_task().

                                                     {
         {
             spin_mutex::scoped_lock lock(my_mutex);
             if ( my_count + my_tries >= my_threshold )
                 return NULL;
             else
                 ++my_tries;
         }
 
         task * rtask = my_successors.try_put_task(t);
 
         if ( !rtask ) {  // try_put_task failed.
             spin_mutex::scoped_lock lock(my_mutex);
             --my_tries;
             if (check_conditions() && internal::is_graph_active(this->my_graph)) {
                 rtask = new ( task::allocate_additional_child_of( *(this->my_graph.root_task()) ) )
                     internal::forward_task_bypass< limiter_node<T, DecrementType> >( *this );
             }
         }
         else {
             spin_mutex::scoped_lock lock(my_mutex);
             ++my_count;
             --my_tries;
              }
         return rtask;
     }