Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface11::sequencer_node< T, Allocator > Class Template Reference

Forwards messages in sequence order. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::sequencer_node< T, Allocator >:
Collaboration diagram for tbb::flow::interface11::sequencer_node< T, Allocator >:

Public Types

typedef T input_type
 
typedef T output_type
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef sender< output_type >::successor_type successor_type
 
- Public Types inherited from tbb::flow::interface11::queue_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) >
typedef T input_type
 
typedef T output_type
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef sender< output_type >::successor_type successor_type
 
- Public Types inherited from tbb::flow::interface11::buffer_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) >
typedef T input_type
 
typedef T output_type
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef sender< output_type >::successor_type successor_type
 
typedef buffer_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) > class_type
 
- Public Types inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
enum  buffer_item_state
 
typedef T item_type
 

Public Member Functions

 __TBB_STATIC_ASSERT ((tbb::internal::is_same_type< Allocator, null_type >::value), "Allocator template parameter for flow graph nodes is deprecated and will be removed. " "Specify TBB_DEPRECATED_FLOW_NODE_ALLOCATOR to temporary enable the deprecated interface.")
 
template<typename Sequencer >
__TBB_NOINLINE_SYM sequencer_node (graph &g, const Sequencer &s)
 Constructor. More...
 
__TBB_NOINLINE_SYM sequencer_node (const sequencer_node &src)
 Copy constructor. More...
 
 ~sequencer_node ()
 Destructor. More...
 
- Public Member Functions inherited from tbb::flow::interface11::queue_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) >
__TBB_NOINLINE_SYM queue_node (graph &g)
 Constructor. More...
 
__TBB_NOINLINE_SYM queue_node (const queue_node &src)
 Copy constructor. More...
 
- Public Member Functions inherited from tbb::flow::interface11::buffer_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) >
 __TBB_STATIC_ASSERT ((tbb::internal::is_same_type< __TBB_DEFAULT_NODE_ALLOCATOR(T), null_type >::value), "__TBB_DEFAULT_NODE_ALLOCATOR(T) template parameter for flow graph nodes is deprecated and will be removed. " "Specify TBB_DEPRECATED_FLOW_NODE_ALLOCATOR to temporary enable the deprecated interface.")
 
__TBB_NOINLINE_SYM buffer_node (graph &g)
 Constructor. More...
 
__TBB_NOINLINE_SYM buffer_node (const buffer_node &src)
 Copy constructor. More...
 
bool register_successor (successor_type &r) __TBB_override
 Adds a new successor. More...
 
bool remove_successor (successor_type &r) __TBB_override
 Removes a successor. More...
 
bool try_get (T &v) __TBB_override
 Request an item from the buffer_node. More...
 
bool try_reserve (T &v) __TBB_override
 Reserves an item. More...
 
bool try_release () __TBB_override
 Release a reserved item. More...
 
bool try_consume () __TBB_override
 Consumes a reserved item. More...
 
- Public Member Functions inherited from tbb::flow::interface11::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- Public Member Functions inherited from internal::reservable_item_buffer< T, cache_aligned_allocator< T > >
 reservable_item_buffer ()
 
void reset ()
 
- Public Member Functions inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
 item_buffer ()
 Constructor. More...
 
 ~item_buffer ()
 
void reset ()
 
- Public Member Functions inherited from tbb::flow::interface11::receiver< T >
virtual ~receiver ()
 Destructor. More...
 
bool try_put (const T &t)
 Put an item to the receiver. More...
 
virtual __TBB_DEPRECATED bool register_predecessor (predecessor_type &)
 Add a predecessor to the node. More...
 
virtual __TBB_DEPRECATED bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node. More...
 
- Public Member Functions inherited from tbb::flow::interface11::sender< T >
virtual ~sender ()
 
virtual __TBB_DEPRECATED bool register_successor (successor_type &r)=0
 Add a new successor to this node. More...
 
virtual __TBB_DEPRECATED bool remove_successor (successor_type &r)=0
 Removes a successor from this node. More...
 

Protected Types

typedef buffer_node< T, Allocator >::size_type size_type
 
typedef buffer_node< T, Allocator >::buffer_operation sequencer_operation
 
- Protected Types inherited from tbb::flow::interface11::queue_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) >
typedef buffer_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) > base_type
 
typedef base_type::size_type size_type
 
typedef base_type::buffer_operation queue_operation
 
typedef queue_node class_type
 
- Protected Types inherited from tbb::flow::interface11::buffer_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) >
enum  op_type
 
typedef size_t size_type
 
typedef internal::aggregating_functor< class_type, buffer_operation > handler_type
 
- Protected Types inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
typedef size_t size_type
 
typedef aligned_pair< item_type, buffer_item_state >::type buffer_item_type
 
typedef tbb::internal::allocator_rebind< cache_aligned_allocator< T >, buffer_item_type >::type allocator_type
 

Private Member Functions

bool internal_push (sequencer_operation *op) __TBB_override
 

Private Attributes

internal::function_body< T, size_t > * my_sequencer
 

Additional Inherited Members

- Public Attributes inherited from tbb::flow::interface11::receiver< T >
__TBB_DEPRECATED typedef T input_type
 The input type of this receiver. More...
 
__TBB_DEPRECATED typedef sender< T > predecessor_type
 The predecessor type for this node. More...
 
- Public Attributes inherited from tbb::flow::interface11::sender< T >
__TBB_DEPRECATED typedef T output_type
 The output type of this sender. More...
 
__TBB_DEPRECATED typedef receiver< T > successor_type
 The successor type for this node. More...
 
- Protected Member Functions inherited from tbb::flow::interface11::queue_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) >
void internal_forward_task (queue_operation *op) __TBB_override
 
void internal_pop (queue_operation *op) __TBB_override
 
void internal_reserve (queue_operation *op) __TBB_override
 
void internal_consume (queue_operation *op) __TBB_override
 
void reset_node (reset_flags f) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::buffer_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) >
virtual void handle_operations (buffer_operation *op_list)
 
void handle_operations_impl (buffer_operation *op_list, derived_type *derived)
 
taskgrab_forwarding_task (buffer_operation &op_data)
 
bool enqueue_forwarding_task (buffer_operation &op_data)
 
virtual taskforward_task ()
 This is executed by an enqueued task, the "forwarder". More...
 
virtual void internal_reg_succ (buffer_operation *op)
 Register successor. More...
 
virtual void internal_rem_succ (buffer_operation *op)
 Remove successor. More...
 
virtual void internal_forward_task (buffer_operation *op)
 Tries to forward valid items to successors. More...
 
void internal_forward_task_impl (buffer_operation *op, derived_type *derived)
 
virtual bool internal_push (buffer_operation *op)
 
virtual void internal_pop (buffer_operation *op)
 
virtual void internal_reserve (buffer_operation *op)
 
virtual void internal_consume (buffer_operation *op)
 
virtual void internal_release (buffer_operation *op)
 
tasktry_put_task (const T &t) __TBB_override
 receive an item, return a task *if possible More...
 
graphgraph_reference () const __TBB_override
 
void reset_receiver (reset_flags) __TBB_override
 put receiver back in initial state More...
 
- Protected Member Functions inherited from internal::reservable_item_buffer< T, cache_aligned_allocator< T > >
bool reserve_front (T &v)
 
void consume_front ()
 
void release_front ()
 
- Protected Member Functions inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
bool buffer_empty () const
 
buffer_item_typeitem (size_type i)
 
const buffer_item_typeitem (size_type i) const
 
bool my_item_valid (size_type i) const
 
bool my_item_reserved (size_type i) const
 
const item_typeget_my_item (size_t i) const
 
void set_my_item (size_t i, const item_type &o)
 
void fetch_item (size_t i, item_type &o)
 
void move_item (size_t to, size_t from)
 
bool place_item (size_t here, const item_type &me)
 
void swap_items (size_t i, size_t j)
 
void destroy_item (size_type i)
 
const item_typefront () const
 
const item_typeback () const
 
void reserve_item (size_type i)
 
void release_item (size_type i)
 
void destroy_front ()
 
void destroy_back ()
 
size_type size (size_t new_tail=0)
 
size_type capacity ()
 
bool buffer_full ()
 
void grow_my_array (size_t minimum_size)
 Grows the internal array. More...
 
bool push_back (item_type &v)
 
bool pop_back (item_type &v)
 
bool pop_front (item_type &v)
 
void clean_up_buffer (bool reset_pointers)
 
- Protected Member Functions inherited from tbb::flow::interface11::receiver< T >
virtual graphgraph_reference () const =0
 
virtual bool is_continue_receiver ()
 
- Protected Attributes inherited from tbb::flow::interface11::buffer_node< T, __TBB_DEFAULT_NODE_ALLOCATOR(T) >
internal::round_robin_cache< T, null_rw_mutexmy_successors
 
bool forwarder_busy
 
internal::aggregator< handler_type, buffer_operation > my_aggregator
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 
- Protected Attributes inherited from internal::reservable_item_buffer< T, cache_aligned_allocator< T > >
bool my_reserved
 
- Protected Attributes inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
buffer_item_typemy_array
 
size_type my_array_size
 
size_type my_head
 
size_type my_tail
 
- Static Protected Attributes inherited from internal::item_buffer< T, cache_aligned_allocator< T > >
static const size_type initial_buffer_size
 

Detailed Description

template<typename T, typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
class tbb::flow::interface11::sequencer_node< T, Allocator >

Forwards messages in sequence order.

Definition at line 2660 of file flow_graph.h.

Member Typedef Documentation

◆ input_type

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
typedef T tbb::flow::interface11::sequencer_node< T, Allocator >::input_type

Definition at line 2672 of file flow_graph.h.

◆ output_type

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
typedef T tbb::flow::interface11::sequencer_node< T, Allocator >::output_type

Definition at line 2673 of file flow_graph.h.

◆ predecessor_type

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
typedef receiver<input_type>::predecessor_type tbb::flow::interface11::sequencer_node< T, Allocator >::predecessor_type

Definition at line 2674 of file flow_graph.h.

◆ sequencer_operation

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
typedef buffer_node<T, Allocator>::buffer_operation tbb::flow::interface11::sequencer_node< T, Allocator >::sequencer_operation
protected

Definition at line 2713 of file flow_graph.h.

◆ size_type

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
typedef buffer_node<T, Allocator>::size_type tbb::flow::interface11::sequencer_node< T, Allocator >::size_type
protected

Definition at line 2712 of file flow_graph.h.

◆ successor_type

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
typedef sender<output_type>::successor_type tbb::flow::interface11::sequencer_node< T, Allocator >::successor_type

Definition at line 2675 of file flow_graph.h.

Constructor & Destructor Documentation

◆ sequencer_node() [1/2]

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
template<typename Sequencer >
__TBB_NOINLINE_SYM tbb::flow::interface11::sequencer_node< T, Allocator >::sequencer_node ( graph g,
const Sequencer &  s 
)
inline

Constructor.

Definition at line 2679 of file flow_graph.h.

2679  : queue_node<T, Allocator>(g),
2681  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_SEQUENCER_NODE, &(this->my_graph),
2682  static_cast<receiver<input_type> *>(this),
2683  static_cast<sender<output_type> *>(this) );
2684  }

References CODEPTR, tbb::internal::fgt_node(), and tbb::flow::interface11::graph_node::my_graph.

Here is the call graph for this function:

◆ sequencer_node() [2/2]

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
__TBB_NOINLINE_SYM tbb::flow::interface11::sequencer_node< T, Allocator >::sequencer_node ( const sequencer_node< T, Allocator > &  src)
inline

Copy constructor.

Definition at line 2695 of file flow_graph.h.

2695  : queue_node<T, Allocator>(src),
2696  my_sequencer( src.my_sequencer->clone() ) {
2697  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_SEQUENCER_NODE, &(this->my_graph),
2698  static_cast<receiver<input_type> *>(this),
2699  static_cast<sender<output_type> *>(this) );
2700  }

References CODEPTR, tbb::internal::fgt_node(), and tbb::flow::interface11::graph_node::my_graph.

Here is the call graph for this function:

◆ ~sequencer_node()

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
tbb::flow::interface11::sequencer_node< T, Allocator >::~sequencer_node ( )
inline

Destructor.

Definition at line 2703 of file flow_graph.h.

2703 { delete my_sequencer; }

References tbb::flow::interface11::sequencer_node< T, Allocator >::my_sequencer.

Member Function Documentation

◆ __TBB_STATIC_ASSERT()

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
tbb::flow::interface11::sequencer_node< T, Allocator >::__TBB_STATIC_ASSERT ( (tbb::internal::is_same_type< Allocator, null_type >::value ,
"Allocator template parameter for flow graph nodes is deprecated and will be removed. " "Specify TBB_DEPRECATED_FLOW_NODE_ALLOCATOR to temporary enable the deprecated interface."   
)

◆ internal_push()

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
bool tbb::flow::interface11::sequencer_node< T, Allocator >::internal_push ( sequencer_operation op)
inlineprivate

Definition at line 2716 of file flow_graph.h.

2716  {
2717  size_type tag = (*my_sequencer)(*(op->elem));
2718 #if !TBB_DEPRECATED_SEQUENCER_DUPLICATES
2719  if (tag < this->my_head) {
2720  // have already emitted a message with this tag
2722  return false;
2723  }
2724 #endif
2725  // cannot modify this->my_tail now; the buffer would be inconsistent.
2726  size_t new_tail = (tag+1 > this->my_tail) ? tag+1 : this->my_tail;
2727 
2728  if (this->size(new_tail) > this->capacity()) {
2729  this->grow_my_array(this->size(new_tail));
2730  }
2731  this->my_tail = new_tail;
2732 
2733  const internal::op_stat res = this->place_item(tag, *(op->elem)) ? internal::SUCCEEDED : internal::FAILED;
2734  __TBB_store_with_release(op->status, res);
2735  return res ==internal::SUCCEEDED;
2736  }

References tbb::internal::__TBB_store_with_release(), internal::item_buffer< T, cache_aligned_allocator< T > >::capacity(), internal::FAILED, internal::item_buffer< T, cache_aligned_allocator< T > >::grow_my_array(), internal::item_buffer< T, cache_aligned_allocator< T > >::my_head, internal::item_buffer< T, cache_aligned_allocator< T > >::my_tail, internal::item_buffer< T, cache_aligned_allocator< T > >::place_item(), internal::item_buffer< T, cache_aligned_allocator< T > >::size(), and internal::SUCCEEDED.

Here is the call graph for this function:

Member Data Documentation

◆ my_sequencer

template<typename T , typename Allocator = __TBB_DEFAULT_NODE_ALLOCATOR(T)>
internal::function_body< T, size_t >* tbb::flow::interface11::sequencer_node< T, Allocator >::my_sequencer
private

The documentation for this class was generated from the following file:
internal::SUCCEEDED
@ SUCCEEDED
Definition: _flow_graph_types_impl.h:719
CODEPTR
#define CODEPTR()
Definition: _flow_graph_trace_impl.h:297
tbb::flow::interface11::graph_node::my_graph
graph & my_graph
Definition: _flow_graph_impl.h:464
internal::item_buffer< T, cache_aligned_allocator< T > >::grow_my_array
void grow_my_array(size_t minimum_size)
Grows the internal array.
Definition: _flow_graph_item_buffer_impl.h:158
tbb::flow::interface11::sequencer_node::size_type
buffer_node< T, Allocator >::size_type size_type
Definition: flow_graph.h:2712
internal::item_buffer< T, cache_aligned_allocator< T > >::capacity
size_type capacity()
Definition: _flow_graph_item_buffer_impl.h:152
internal::op_stat
op_stat
Definition: _flow_graph_types_impl.h:719
internal::function_body_leaf
the leaf for function_body
Definition: _flow_graph_body_impl.h:128
internal::item_buffer< T, cache_aligned_allocator< T > >::my_tail
size_type my_tail
Definition: _flow_graph_item_buffer_impl.h:52
tbb::internal::__TBB_store_with_release
void __TBB_store_with_release(volatile T &location, V value)
Definition: tbb_machine.h:713
internal::item_buffer< T, cache_aligned_allocator< T > >::my_head
size_type my_head
Definition: _flow_graph_item_buffer_impl.h:51
tbb::flow::interface11::sequencer_node::my_sequencer
internal::function_body< T, size_t > * my_sequencer
Definition: flow_graph.h:2661
s
void const char const char int ITT_FORMAT __itt_group_sync s
Definition: ittnotify_static.h:91
internal::FAILED
@ FAILED
Definition: _flow_graph_types_impl.h:719
tbb::internal::fgt_node
static void fgt_node(void *, string_index, void *, void *)
Definition: _flow_graph_trace_impl.h:326
internal::item_buffer< T, cache_aligned_allocator< T > >::size
size_type size(size_t new_tail=0)
Definition: _flow_graph_item_buffer_impl.h:151
internal::item_buffer< T, cache_aligned_allocator< T > >::place_item
bool place_item(size_t here, const item_type &me)
Definition: _flow_graph_item_buffer_impl.h:106

Copyright © 2005-2020 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.