Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface10::receiver< T > Class Template Referenceabstract

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

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::receiver< T >:
Collaboration diagram for tbb::flow::interface10::receiver< T >:

Public Types

typedef T input_type
 The input type of this receiver. More...
 
typedef internal::async_helpers< T >::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

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::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...
 
virtual bool register_predecessor (predecessor_type &)
 Add a predecessor to the node. More...
 
virtual bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node. More...
 

Protected Member Functions

virtual tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
virtual tasktry_put_task (const T &t)=0
 Put item to successor; return task to run the successor if possible. More...
 
- Protected Member Functions inherited from tbb::flow::interface10::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
virtual graphgraph_reference ()=0
 
virtual void reset_receiver (reset_flags f=rf_reset_protocol)=0
 put receiver back in initial state More...
 
virtual bool is_continue_receiver ()
 

Friends

template<typename >
class internal::async_storage
 
template<typename , typename >
struct internal::async_helpers
 

Detailed Description

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

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

Definition at line 100 of file flow_graph.h.

Member Typedef Documentation

◆ filtered_type

Definition at line 442 of file flow_graph.h.

◆ input_type

template<typename T>
typedef T tbb::flow::interface10::receiver< T >::input_type

The input type of this receiver.

Definition at line 440 of file flow_graph.h.

Member Function Documentation

◆ try_put() [1/2]

template<typename T>
bool tbb::flow::interface10::receiver< T >::try_put ( const typename internal::async_helpers< T >::filtered_type t)
inline

Put an item to the receiver.

Definition at line 445 of file flow_graph.h.

445  {
447  }
bool try_put(const X &t)
Put an item to the receiver.
Definition: flow_graph.h:350

◆ try_put() [2/2]

template<typename T>
bool tbb::flow::interface10::receiver< T >::try_put ( const typename internal::async_helpers< T >::async_type &  t)
inline

Definition at line 449 of file flow_graph.h.

449  {
451  }
bool try_put(const X &t)
Put an item to the receiver.
Definition: flow_graph.h:350

◆ try_put_task()

template<typename T>
virtual task* tbb::flow::interface10::receiver< T >::try_put_task ( const T &  t)
protectedpure virtual

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

Implemented in tbb::flow::interface10a::write_once_node< T >, tbb::flow::interface10a::overwrite_node< T >, tbb::flow::interface10::limiter_node< T >, tbb::flow::interface10::buffer_node< T, A >, tbb::flow::interface10::broadcast_node< T >, tbb::flow::interface10::split_node< TupleType, Allocator >, tbb::flow::interface10::internal::key_matching_port< TraitsType >, internal::key_matching_port< TraitsType >, tbb::flow::interface10::continue_receiver, tbb::flow::interface10::internal::queueing_port< T >, tbb::flow::interface10::internal::reserving_port< T >, tbb::flow::interface10::internal::indexer_input_port< T >, tbb::flow::interface10::internal::function_input_base< Input, Policy, A, ImplType >, internal::function_input_base< Input, Policy, A, ImplType >, tbb::flow::interface10::internal::function_input_base< Input, Policy, A, function_input< Input, Output, Policy, A > >, tbb::flow::interface10::internal::function_input_base< kernel_input_tuple, queueing, cache_aligned_allocator< kernel_input_tuple >, multifunction_input< kernel_input_tuple, internal::wrap_tuple_elements< tbb::flow::tuple_size< output_tuple >::value, internal::multifunction_output, output_tuple >::type, queueing, cache_aligned_allocator< kernel_input_tuple > > >, tbb::flow::interface10::internal::function_input_base< Input, Policy, Allocator, function_input< Input, Output, Policy, Allocator > >, tbb::flow::interface10::internal::function_input_base< Input, Policy, Allocator, multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< tuple< Output > >::value, internal::multifunction_output, tuple< Output > >::type, Policy, Allocator > >, tbb::flow::interface10::internal::function_input_base< Input, Policy, A, multifunction_input< Input, OutputPortSet, Policy, A > >, tbb::flow::interface10::internal::function_input_base< indexer_node_output_type, queueing, cache_aligned_allocator< indexer_node_output_type >, multifunction_input< indexer_node_output_type, internal::wrap_tuple_elements< tbb::flow::tuple_size< kernel_input_tuple >::value, internal::multifunction_output, kernel_input_tuple >::type, queueing, cache_aligned_allocator< indexer_node_output_type > > >, tbb::flow::interface10::internal::function_input_base< Input, Policy, Allocator, multifunction_input< Input, internal::wrap_tuple_elements< tbb::flow::tuple_size< Output >::value, internal::multifunction_output, Output >::type, Policy, Allocator > >, internal::function_input_base< Input, Policy, A, function_input< Input, Output, Policy, A > >, and internal::function_input_base< Input, Policy, A, multifunction_input< Input, OutputPortSet, Policy, A > >.

◆ try_put_task_wrapper()

template<typename T>
virtual task* tbb::flow::interface10::receiver< T >::try_put_task_wrapper ( const void p,
bool  is_async 
)
inlineprotectedvirtual

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

Definition at line 454 of file flow_graph.h.

454  {
456  }
void const char const char int ITT_FORMAT __itt_group_sync p
static task * try_put_task_wrapper_impl(receiver< T > *const this_recv, const void *p, bool is_async)
Definition: flow_graph.h:217

Friends And Related Function Documentation

◆ internal::async_helpers

template<typename T>
template<typename , typename >
friend struct internal::async_helpers
friend

Definition at line 437 of file flow_graph.h.

◆ internal::async_storage

template<typename T>
template<typename >
friend class internal::async_storage
friend

Definition at line 436 of file flow_graph.h.


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

Copyright © 2005-2019 Intel Corporation. All Rights Reserved.

Intel, Pentium, Intel Xeon, Itanium, Intel XScale and VTune are registered trademarks or trademarks of Intel Corporation or its subsidiaries in the United States and other countries.

* Other names and brands may be claimed as the property of others.