tbb::flow::interface11::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.h>

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

Collaboration diagram for tbb::flow::interface11::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 tbb::flow::interface11::internal::function_input_base< Input, Policy, A, function_input< Input, Output, Policy, A > >
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 tbb::internal::allocator_rebind< A, input_queue_type >::type	queue_allocator_type
Public Types inherited from tbb::flow::interface11::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,)
	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 tbb::flow::interface11::internal::function_input_base< Input, Policy, A, function_input< Input, Output, Policy, A > >
	__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, __TBB_FLOW_GRAPH_PRIORITY_ARG1(size_t max_concurrency, node_priority_t priority))
	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::interface11::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::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...

Protected Member Functions
void	reset_function_input (reset_flags f)
virtual broadcast_cache< output_type > &	successors ()=0
Protected Member Functions inherited from tbb::flow::interface11::internal::function_input_base< Input, Policy, A, function_input< Input, Output, Policy, A > >
void	reset_function_input_base (reset_flags f)
void	reset_receiver (reset_flags f) __TBB_override
	put receiver back in initial state More...
graph &	graph_reference () const __TBB_override
task *	try_get_postponed_task (const input_type &i)
Protected Member Functions inherited from tbb::flow::interface11::receiver< Input >
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 Attributes
function_body_type *	my_body
function_body_type *	my_init_body
Protected Attributes inherited from tbb::flow::interface11::internal::function_input_base< Input, Policy, A, function_input< Input, Output, Policy, A > >
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

Additional Inherited Members
Public Attributes inherited from tbb::flow::interface11::receiver< Input >
__TBB_DEPRECATED typedef Input	input_type
	The input type of this receiver. More...
__TBB_DEPRECATED typedef internal::async_helpers< Input >::filtered_type	filtered_type

Detailed Description

template<typename Input, typename Output, typename Policy, typename A>
class tbb::flow::interface11::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.h.

Member Typedef Documentation

base_type

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

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

Definition at line 427 of file flow_graph.h.

function_body_type

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

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

Definition at line 425 of file flow_graph.h.

input_queue_type

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

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

Definition at line 428 of file flow_graph.h.

input_type

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

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

Definition at line 423 of file flow_graph.h.

my_class

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

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

Definition at line 426 of file flow_graph.h.

output_type

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

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

Definition at line 424 of file flow_graph.h.

Constructor & Destructor Documentation

function_input() [1/2]

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

template<typename Body >

tbb::flow::interface11::internal::function_input< Input, Output, Policy, A >::function_input ( graph &  g, size_t  max_concurrency  )

inline

Definition at line 432 of file flow_graph.h.

                                { return false; }

    virtual bool try_reserve( T & ) { return false; }

protected:

function_input() [2/2]

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

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

inline

Copy constructor.

Definition at line 441 of file flow_graph.h.

                                                                 {
            return try_get( internal::async_helpers<T>::from_void_ptr(p) );
        }
        // Else: this (T) is async OR incoming 't' is async
        __TBB_ASSERT(false, "async_msg interface does not support 'pull' protocol in try_get()");

~function_input()

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

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

inline

Definition at line 447 of file flow_graph.h.

                                                                              {
        // Both async OR both are NOT async

Member Function Documentation

apply_body_impl()

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

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

inline

Definition at line 458 of file flow_graph.h.

               : public internal::untyped_receiver {
    template< typename > friend class internal::async_storage;
    template< typename, typename > friend struct internal::async_helpers;
public:

apply_body_impl_bypass()

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

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

inline

Definition at line 468 of file flow_graph.h.

                                                                            {
        return internal::untyped_receiver::try_put(t);
    }

    bool try_put( const typename internal::async_helpers<T>::async_type& t ) {
        return internal::untyped_receiver::try_put(t);
    }

protected:
    virtual task* try_put_task_wrapper( const void *p, bool is_async ) __TBB_override {
        return internal::async_helpers<T>::try_put_task_wrapper_impl(this, p, is_async);
    }

    virtual task *try_put_task(const T& t) = 0;

}; // class receiver<T>

#else // __TBB_PREVIEW_ASYNC_MSG

template< typename T >
class sender {
public:
    __TBB_DEPRECATED typedef T output_type;

    __TBB_DEPRECATED typedef receiver<T> successor_type;

    virtual ~sender() {}

    // NOTE: Following part of PUBLIC section is partly copy-pasted in sender<T> under #if __TBB_PREVIEW_ASYNC_MSG

copy_function_object()

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

template<typename Body >

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

inline

Definition at line 453 of file flow_graph.h.

               : public internal::untyped_receiver {

reset_function_input()

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

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

inlineprotected

Definition at line 508 of file flow_graph.h.

                                { return false; }

Referenced by tbb::flow::interface11::function_node< Input, Output, Policy, Allocator >::reset_node().

Here is the caller graph for this function:

successors()

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

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

protectedpure virtual

Implemented in tbb::flow::interface11::function_node< Input, Output, Policy, Allocator >.

Member Data Documentation

my_body

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

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

protected

Definition at line 517 of file flow_graph.h.

my_init_body

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

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

protected

Definition at line 518 of file flow_graph.h.

---

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

• flow_graph.h