tbb::flow::interface10::continue_receiver Class Reference

Base class for receivers of completion messages. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::continue_receiver:

Collaboration diagram for tbb::flow::interface10::continue_receiver:

Public Types
typedef continue_msg	input_type
	The input type. More...
typedef receiver< input_type >::predecessor_type	predecessor_type
	The predecessor type for this node. More...
Public Types inherited from tbb::flow::interface10::receiver< continue_msg >
typedef continue_msg	input_type
	The input type of this receiver. More...
typedef internal::async_helpers< continue_msg >::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 Member Functions
	continue_receiver (__TBB_FLOW_GRAPH_PRIORITY_ARG1(int number_of_predecessors, node_priority_t priority))
	Constructor. More...
	continue_receiver (const continue_receiver &src)
	Copy constructor. More...
bool	register_predecessor (predecessor_type &) __TBB_override
	Increments the trigger threshold. More...
bool	remove_predecessor (predecessor_type &) __TBB_override
	Decrements the trigger threshold. More...
Public Member Functions inherited from tbb::flow::interface10::receiver< continue_msg >
bool	try_put (const typename internal::async_helpers< continue_msg >::filtered_type &t)
	Put an item to the receiver. More...
bool	try_put (const typename internal::async_helpers< continue_msg >::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...

Protected Member Functions
task *	try_put_task (const input_type &) __TBB_override
	Put item to successor; return task to run the successor if possible. More...
void	reset_receiver (reset_flags f) __TBB_override
	put receiver back in initial state More...
virtual task *	execute ()=0
	Does whatever should happen when the threshold is reached. More...
bool	is_continue_receiver () __TBB_override
Protected Member Functions inherited from tbb::flow::interface10::receiver< continue_msg >
virtual task *	try_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 >
task *	try_put_task (const X &t)
virtual graph &	graph_reference ()=0

Protected Attributes
spin_mutex	my_mutex
int	my_predecessor_count
int	my_current_count
int	my_initial_predecessor_count

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
template<typename U , typename V >
class	tbb::flow::interface11::limiter_node
template<typename TT , typename M >
class	internal::successor_cache

Detailed Description

Base class for receivers of completion messages.

These receivers automatically reset, but cannot be explicitly waited on

Definition at line 571 of file flow_graph.h.

Member Typedef Documentation

input_type

typedef continue_msg tbb::flow::interface10::continue_receiver::input_type

The input type.

Definition at line 575 of file flow_graph.h.

predecessor_type

typedef receiver<input_type>::predecessor_type tbb::flow::interface10::continue_receiver::predecessor_type

The predecessor type for this node.

Definition at line 578 of file flow_graph.h.

Constructor & Destructor Documentation

continue_receiver() [1/2]

tbb::flow::interface10::continue_receiver::continue_receiver ( __TBB_FLOW_GRAPH_PRIORITY_ARG1(int number_of_predecessors, node_priority_t priority)  )

inlineexplicit

Constructor.

Definition at line 581 of file flow_graph.h.

                                                                                              {
        my_predecessor_count = my_initial_predecessor_count = number_of_predecessors;
        my_current_count = 0;
        __TBB_FLOW_GRAPH_PRIORITY_EXPR( my_priority = priority; )
    }

continue_receiver() [2/2]

tbb::flow::interface10::continue_receiver::continue_receiver ( const continue_receiver &  src )

inline

Copy constructor.

Definition at line 589 of file flow_graph.h.

                                                      : receiver<continue_msg>() {
        my_predecessor_count = my_initial_predecessor_count = src.my_initial_predecessor_count;
        my_current_count = 0;
        __TBB_FLOW_GRAPH_PRIORITY_EXPR( my_priority = src.my_priority; )
    }

Member Function Documentation

execute()

virtual task* tbb::flow::interface10::continue_receiver::execute ( )

protectedpure virtual

Does whatever should happen when the threshold is reached.

This should be very fast or else spawn a task. This is called while the sender is blocked in the try_put().

Implemented in tbb::flow::interface10::internal::continue_input< Output, Policy >, and tbb::flow::interface10::internal::decrementer< T, continue_msg, void >.

is_continue_receiver()

bool tbb::flow::interface10::continue_receiver::is_continue_receiver ( )

inlineprotectedvirtual

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

Definition at line 685 of file flow_graph.h.

{ return true; }

register_predecessor()

bool tbb::flow::interface10::continue_receiver::register_predecessor ( predecessor_type &  )

inlinevirtual

Increments the trigger threshold.

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

Definition at line 596 of file flow_graph.h.

                                                                   {
        spin_mutex::scoped_lock l(my_mutex);
        ++my_predecessor_count;
        return true;
    }

remove_predecessor()

bool tbb::flow::interface10::continue_receiver::remove_predecessor ( predecessor_type &  )

inlinevirtual

Decrements the trigger threshold.

Does not check to see if the removal of the predecessor now makes the current count exceed the new threshold. So removing a predecessor while the graph is active can cause unexpected results.

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

Definition at line 606 of file flow_graph.h.

                                                                 {
        spin_mutex::scoped_lock l(my_mutex);
        --my_predecessor_count;
        return true;
    }

reset_receiver()

void tbb::flow::interface10::continue_receiver::reset_receiver ( reset_flags  f )

inlineprotectedvirtual

put receiver back in initial state

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

Reimplemented in tbb::flow::interface10::internal::continue_input< Output, Policy >.

Definition at line 670 of file flow_graph.h.

                                                        {
        my_current_count = 0;
        if (f & rf_clear_edges) {
#if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
            my_built_predecessors.clear();
#endif
            my_predecessor_count = my_initial_predecessor_count;
        }
    }

try_put_task()

task* tbb::flow::interface10::continue_receiver::try_put_task ( const input_type &  t )

inlineprotectedvirtual

Put item to successor; return task to run the successor if possible.

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

Definition at line 644 of file flow_graph.h.

                                                            {
        {
            spin_mutex::scoped_lock l(my_mutex);
            if ( ++my_current_count < my_predecessor_count )
                return SUCCESSFULLY_ENQUEUED;
            else
                my_current_count = 0;
        }
        task * res = execute();
        return res? res : SUCCESSFULLY_ENQUEUED;
    }

Friends And Related Function Documentation

internal::broadcast_cache

template<typename X , typename Y >

friend class internal::broadcast_cache

friend

Definition at line 641 of file flow_graph.h.

internal::round_robin_cache

template<typename X , typename Y >

friend class internal::round_robin_cache

friend

Definition at line 642 of file flow_graph.h.

internal::successor_cache

template<typename TT , typename M >

friend class internal::successor_cache

friend

Definition at line 684 of file flow_graph.h.

run_and_put_task

template<typename R , typename B >

friend class run_and_put_task

friend

Definition at line 640 of file flow_graph.h.

tbb::flow::interface11::limiter_node

template<typename U , typename V >

friend class tbb::flow::interface11::limiter_node

friend

Definition at line 668 of file flow_graph.h.

Member Data Documentation

my_current_count

int tbb::flow::interface10::continue_receiver::my_current_count

protected

Definition at line 663 of file flow_graph.h.

my_initial_predecessor_count

int tbb::flow::interface10::continue_receiver::my_initial_predecessor_count

protected

Definition at line 664 of file flow_graph.h.

my_mutex

spin_mutex tbb::flow::interface10::continue_receiver::my_mutex

protected

Definition at line 661 of file flow_graph.h.

my_predecessor_count

int tbb::flow::interface10::continue_receiver::my_predecessor_count

protected

Definition at line 662 of file flow_graph.h.

---

The documentation for this class was generated from the following file:

• flow_graph.h