Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
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

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()

◆ 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.

411  {
412  // Both async OR both are NOT async
413  if ( internal::async_helpers<T>::is_async_type == is_async ) {
415  }
416  // Else: this (T) is async OR incoming 't' is async
417  __TBB_ASSERT(false, "async_msg interface does not support 'pull' protocol in try_get()");
418  return false;
419  }
virtual bool try_get(T &)
Request an item from the sender.
Definition: flow_graph.h:405
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
static const T & from_void_ptr(const void *p)
Definition: flow_graph.h:209
void const char const char int ITT_FORMAT __itt_group_sync p

◆ 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.

408 { 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.

421  {
422  // Both async OR both are NOT async
423  if ( internal::async_helpers<T>::is_async_type == is_async ) {
425  }
426  // Else: this (T) is async OR incoming 't' is async
427  __TBB_ASSERT(false, "async_msg interface does not support 'pull' protocol in try_reserve()");
428  return false;
429  }
virtual bool try_reserve(T &)
Reserves an item in the sender.
Definition: flow_graph.h:408
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
static const T & from_void_ptr(const void *p)
Definition: flow_graph.h:209
void const char const char int ITT_FORMAT __itt_group_sync p

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.