tbb::flow::interface10::sender< T > Class Template Reference

Forward declaration section. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::sender< T >:

Collaboration diagram for tbb::flow::interface10::sender< T >:

Public Types
typedef T	output_type
	The output type of this sender. More...
typedef internal::async_helpers< T >::filtered_type	filtered_type
Public Types inherited from tbb::flow::interface10::internal::untyped_sender
typedef untyped_receiver	successor_type
	The successor type for this node. More...

Public Member Functions
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::interface10::internal::untyped_sender
virtual	~untyped_sender ()
virtual bool	register_successor (successor_type &r)=0
	Add a new successor to this node. More...
virtual bool	remove_successor (successor_type &r)=0
	Removes a successor from this node. More...
virtual bool	try_release ()
	Releases the reserved item. More...
virtual bool	try_consume ()
	Consumes the reserved item. More...

Protected Member Functions
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::interface10::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...

Detailed Description

template<typename T>
class tbb::flow::interface10::sender< T >

Forward declaration section.

Pure virtual template class that defines a sender of messages of type T.

Definition at line 95 of file flow_graph.h.

Member Typedef Documentation

filtered_type

template<typename T>

typedef internal::async_helpers<T>::filtered_type tbb::flow::interface10::sender< T >::filtered_type

Definition at line 402 of file flow_graph.h.

output_type

template<typename T>

typedef T tbb::flow::interface10::sender< T >::output_type

The output type of this sender.

Definition at line 400 of file flow_graph.h.

Member Function Documentation

try_get()

template<typename T>

virtual bool tbb::flow::interface10::sender< T >::try_get ( T &  )

inlinevirtual

Request an item from the sender.

Reimplemented in tbb::flow::interface10a::overwrite_node< T >, tbb::flow::interface10::buffer_node< T, A >, tbb::flow::interface10::internal::join_node_base< JP, InputTuple, OutputTuple >, internal::join_node_base< JP, InputTuple, OutputTuple >, and tbb::flow::interface10::source_node< Output >.

Definition at line 405 of file flow_graph.h.

{ return false; }

try_get_wrapper()

template<typename T>

virtual bool tbb::flow::interface10::sender< T >::try_get_wrapper ( void *  p, bool  is_async  )

inlineprotectedvirtual

Implements tbb::flow::interface10::internal::untyped_sender.

Definition at line 411 of file flow_graph.h.

                                                                          {
        // Both async OR both are NOT async
        if ( internal::async_helpers<T>::is_async_type == is_async ) {
            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()");
        return false;
    }

try_reserve()

template<typename T>

virtual bool tbb::flow::interface10::sender< T >::try_reserve ( T &  )

inlinevirtual

Reserves an item in the sender.

Reimplemented in tbb::flow::interface10a::overwrite_node< T >, tbb::flow::interface10::buffer_node< T, A >, and tbb::flow::interface10::source_node< Output >.

Definition at line 408 of file flow_graph.h.

{ return false; }

try_reserve_wrapper()

template<typename T>

virtual bool tbb::flow::interface10::sender< T >::try_reserve_wrapper ( void *  p, bool  is_async  )

inlineprotectedvirtual

Implements tbb::flow::interface10::internal::untyped_sender.

Definition at line 421 of file flow_graph.h.

                                                                              {
        // Both async OR both are NOT async
        if ( internal::async_helpers<T>::is_async_type == is_async ) {
            return try_reserve( 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_reserve()");
        return false;
    }

---

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

• flow_graph.h