internal::function_input< Input, Output, Policy, A > Class Template Reference

Implements methods for a function node that takes a type Input as input and sends. More...

#include <_flow_graph_node_impl.h>

Inheritance diagram for internal::function_input< Input, Output, Policy, A >:

Collaboration diagram for internal::function_input< Input, Output, Policy, A >:

Public Types
typedef Input	input_type
typedef Output	output_type
typedef function_body< input_type, output_type >	function_body_type
typedef function_input< Input, Output, Policy, A >	my_class
typedef function_input_base< Input, Policy, A, my_class >	base_type
typedef function_input_queue< input_type, A >	input_queue_type
Public Types inherited from internal::function_input_base< Input, Policy, A, ImplType >
typedef Input	input_type
	The input type of this receiver. More...
typedef receiver< input_type >::predecessor_type	predecessor_type
typedef predecessor_cache< input_type, null_mutex >	predecessor_cache_type
typedef function_input_queue< input_type, A >	input_queue_type
typedef A::template rebind< input_queue_type >::other	queue_allocator_type
Public Types inherited from tbb::flow::interface10::receiver< Input >
typedef Input	input_type
	The input type of this receiver. More...
typedef internal::async_helpers< Input >::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
template<typename Body >
	function_input (graph &g, size_t max_concurrency, Body &body)
	function_input (const function_input &src)
	Copy constructor. More...
	~function_input ()
template<typename Body >
Body	copy_function_object ()
output_type	apply_body_impl (const input_type &i)
task *	apply_body_impl_bypass (const input_type &i)
Public Member Functions inherited from internal::function_input_base< Input, Policy, A, ImplType >
	__TBB_STATIC_ASSERT (!((internal::has_policy< queueing, Policy >::value) &&(internal::has_policy< rejecting, Policy >::value)), "queueing and rejecting policies can't be specified simultaneously")
	function_input_base (graph &g, size_t max_concurrency)
	Constructor for function_input_base. More...
	function_input_base (const function_input_base &src)
	Copy constructor. More...
virtual	~function_input_base ()
	Destructor. More...
task *	try_put_task (const input_type &t) __TBB_override
	Put item to successor; return task to run the successor if possible. 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::interface10::receiver< Input >
bool	try_put (const typename internal::async_helpers< Input >::filtered_type &t)
	Put an item to the receiver. More...
bool	try_put (const typename internal::async_helpers< Input >::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
void	reset_function_input (reset_flags f)
virtual broadcast_cache< output_type > &	successors ()=0
Protected Member Functions inherited from internal::function_input_base< Input, Policy, A, ImplType >
void	reset_function_input_base (reset_flags f)
void	reset_receiver (reset_flags f) __TBB_override
graph &	graph_reference () __TBB_override
task *	try_get_postponed_task (const input_type &i)
Protected Member Functions inherited from tbb::flow::interface10::receiver< Input >
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 void	reset_receiver (reset_flags f=rf_reset_protocol)=0
	put receiver back in initial state More...
virtual bool	is_continue_receiver ()

Protected Attributes
function_body_type *	my_body
function_body_type *	my_init_body
Protected Attributes inherited from internal::function_input_base< Input, Policy, A, ImplType >
graph &	my_graph_ref
const size_t	my_max_concurrency
size_t	my_concurrency
input_queue_type *	my_queue
predecessor_cache< input_type, null_mutex >	my_predecessors

Detailed Description

template<typename Input, typename Output, typename Policy, typename A>
class internal::function_input< Input, Output, Policy, A >

Implements methods for a function node that takes a type Input as input and sends.

Definition at line 421 of file _flow_graph_node_impl.h.

Member Typedef Documentation

base_type

template<typename Input , typename Output , typename Policy , typename A >

typedef function_input_base<Input, Policy, A, my_class> internal::function_input< Input, Output, Policy, A >::base_type

Definition at line 427 of file _flow_graph_node_impl.h.

function_body_type

template<typename Input , typename Output , typename Policy , typename A >

typedef function_body<input_type, output_type> internal::function_input< Input, Output, Policy, A >::function_body_type

Definition at line 425 of file _flow_graph_node_impl.h.

input_queue_type

template<typename Input , typename Output , typename Policy , typename A >

typedef function_input_queue<input_type, A> internal::function_input< Input, Output, Policy, A >::input_queue_type

Definition at line 428 of file _flow_graph_node_impl.h.

input_type

template<typename Input , typename Output , typename Policy , typename A >

typedef Input internal::function_input< Input, Output, Policy, A >::input_type

Definition at line 423 of file _flow_graph_node_impl.h.

my_class

template<typename Input , typename Output , typename Policy , typename A >

typedef function_input<Input, Output, Policy,A> internal::function_input< Input, Output, Policy, A >::my_class

Definition at line 426 of file _flow_graph_node_impl.h.

output_type

template<typename Input , typename Output , typename Policy , typename A >

typedef Output internal::function_input< Input, Output, Policy, A >::output_type

Definition at line 424 of file _flow_graph_node_impl.h.

Constructor & Destructor Documentation

function_input() [1/2]

template<typename Input , typename Output , typename Policy , typename A >

template<typename Body >

internal::function_input< Input, Output, Policy, A >::function_input ( graph &  g, size_t  max_concurrency, Body &  body  )

inline

Definition at line 432 of file _flow_graph_node_impl.h.

                                                                       :
            base_type(g, max_concurrency),
            my_body( new internal::function_body_leaf< input_type, output_type, Body>(body) ),
            my_init_body( new internal::function_body_leaf< input_type, output_type, Body>(body) ) {
        }

function_input() [2/2]

template<typename Input , typename Output , typename Policy , typename A >

internal::function_input< Input, Output, Policy, A >::function_input ( const function_input< Input, Output, Policy, A > &  src )

inline

Copy constructor.

Definition at line 439 of file _flow_graph_node_impl.h.

                                                    :
                base_type(src),
                my_body( src.my_init_body->clone() ),
                my_init_body(src.my_init_body->clone() ) {
        }

~function_input()

template<typename Input , typename Output , typename Policy , typename A >

internal::function_input< Input, Output, Policy, A >::~function_input ( )

inline

Definition at line 445 of file _flow_graph_node_impl.h.

                          {
            delete my_body;
            delete my_init_body;
        }

References internal::function_input< Input, Output, Policy, A >::my_body, and internal::function_input< Input, Output, Policy, A >::my_init_body.

Member Function Documentation

apply_body_impl()

template<typename Input , typename Output , typename Policy , typename A >

output_type internal::function_input< Input, Output, Policy, A >::apply_body_impl ( const input_type &  i )

inline

Definition at line 456 of file _flow_graph_node_impl.h.

                                                          {
            // There is an extra copied needed to capture the
            // body execution without the try_put
            tbb::internal::fgt_begin_body( my_body );
            output_type v = (*my_body)(i);
            tbb::internal::fgt_end_body( my_body );
            return v;
        }

References tbb::internal::fgt_begin_body(), tbb::internal::fgt_end_body(), and internal::function_input< Input, Output, Policy, A >::my_body.

Referenced by internal::function_input< Input, Output, Policy, A >::apply_body_impl_bypass().

Here is the call graph for this function:

Here is the caller graph for this function:

apply_body_impl_bypass()

template<typename Input , typename Output , typename Policy , typename A >

task* internal::function_input< Input, Output, Policy, A >::apply_body_impl_bypass ( const input_type &  i )

inline

Definition at line 466 of file _flow_graph_node_impl.h.

                                                            {
            output_type v = apply_body_impl(i);
            task* postponed_task = NULL;
#if TBB_DEPRECATED_MESSAGE_FLOW_ORDER
            task* successor_task = successors().try_put_task(v);
#endif
            if(base_type::my_max_concurrency != 0) {
                postponed_task = base_type::try_get_postponed_task(i);
            }
#if TBB_DEPRECATED_MESSAGE_FLOW_ORDER
            graph& g = base_type::my_graph_ref;
            return combine_tasks(g, successor_task, postponed_task);
#else
            // postponed_task is either NULL or the pointer to TBB task
            if(postponed_task) {
                // spawn task to make it available for other workers
                // since we do not know successors' execution policy
                internal::spawn_in_graph_arena(base_type::graph_reference(), *postponed_task);
            }
            task* successor_task = successors().try_put_task(v);
#if _MSC_VER && !__INTEL_COMPILER
#pragma warning (push)
#pragma warning (disable: 4127)  /* suppress conditional expression is constant */
#endif
            if(internal::has_policy<lightweight, Policy>::value) {
#if _MSC_VER && !__INTEL_COMPILER
#pragma warning (pop)
#endif
                if(!successor_task) {
                    // Return confirmative status since current
                    // node's body has been executed anyway
                    successor_task = SUCCESSFULLY_ENQUEUED;
                }
            }
            return successor_task;
#endif /* TBB_DEPRECATED_MESSAGE_FLOW_ORDER */
        }

References internal::function_input< Input, Output, Policy, A >::apply_body_impl(), tbb::flow::interface10::combine_tasks(), internal::function_input_base< Input, Policy, A, ImplType >::graph_reference(), internal::function_input_base< Input, Policy, A, ImplType >::my_graph_ref, internal::function_input_base< Input, Policy, A, ImplType >::my_max_concurrency, tbb::flow::interface10::internal::spawn_in_graph_arena(), tbb::flow::internal::SUCCESSFULLY_ENQUEUED, internal::function_input< Input, Output, Policy, A >::successors(), task, internal::function_input_base< Input, Policy, A, ImplType >::try_get_postponed_task(), and internal::broadcast_cache< T, M >::try_put_task().

Here is the call graph for this function:

copy_function_object()

template<typename Input , typename Output , typename Policy , typename A >

template<typename Body >

Body internal::function_input< Input, Output, Policy, A >::copy_function_object ( )

inline

Definition at line 451 of file _flow_graph_node_impl.h.

                                    {
            function_body_type &body_ref = *this->my_body;
            return dynamic_cast< internal::function_body_leaf<input_type, output_type, Body> & >(body_ref).get_body();
        }

References internal::function_input< Input, Output, Policy, A >::my_body.

reset_function_input()

template<typename Input , typename Output , typename Policy , typename A >

void internal::function_input< Input, Output, Policy, A >::reset_function_input ( reset_flags  f )

inlineprotected

Definition at line 506 of file _flow_graph_node_impl.h.

                                                 {
            base_type::reset_function_input_base(f);
            if(f & rf_reset_bodies) {
                function_body_type *tmp = my_init_body->clone();
                delete my_body;
                my_body = tmp;
            }
        }

References internal::function_body< Input, Output >::clone(), internal::function_input< Input, Output, Policy, A >::my_body, internal::function_input< Input, Output, Policy, A >::my_init_body, internal::function_input_base< Input, Policy, A, ImplType >::reset_function_input_base(), and tbb::flow::interface10::rf_reset_bodies.

Here is the call graph for this function:

successors()

template<typename Input , typename Output , typename Policy , typename A >

virtual broadcast_cache<output_type >& internal::function_input< Input, Output, Policy, A >::successors ( )

protectedpure virtual

Referenced by internal::function_input< Input, Output, Policy, A >::apply_body_impl_bypass().

Here is the caller graph for this function:

Member Data Documentation

my_body

template<typename Input , typename Output , typename Policy , typename A >

function_body_type* internal::function_input< Input, Output, Policy, A >::my_body

protected

Definition at line 515 of file _flow_graph_node_impl.h.

Referenced by internal::function_input< Input, Output, Policy, A >::apply_body_impl(), internal::function_input< Input, Output, Policy, A >::copy_function_object(), internal::function_input< Input, Output, Policy, A >::reset_function_input(), and internal::function_input< Input, Output, Policy, A >::~function_input().

my_init_body

template<typename Input , typename Output , typename Policy , typename A >

function_body_type* internal::function_input< Input, Output, Policy, A >::my_init_body

protected

Definition at line 516 of file _flow_graph_node_impl.h.

Referenced by internal::function_input< Input, Output, Policy, A >::reset_function_input(), and internal::function_input< Input, Output, Policy, A >::~function_input().

---

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

• _flow_graph_node_impl.h