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

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::write_once_node< T >:
Collaboration diagram for tbb::flow::interface11::write_once_node< T >:

Public Types

typedef T input_type
 
typedef T output_type
 
typedef overwrite_node< T > base_type
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef sender< output_type >::successor_type successor_type
 
- Public Types inherited from tbb::flow::interface11::overwrite_node< 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 Member Functions

__TBB_NOINLINE_SYM write_once_node (graph &g)
 Constructor. More...
 
__TBB_NOINLINE_SYM write_once_node (const write_once_node &src)
 Copy constructor: call base class copy constructor. More...
 
- Public Member Functions inherited from tbb::flow::interface11::overwrite_node< T >
__TBB_NOINLINE_SYM overwrite_node (graph &g)
 
__TBB_NOINLINE_SYM overwrite_node (const overwrite_node &src)
 Copy constructor; doesn't take anything from src; default won't work. More...
 
 ~overwrite_node ()
 
bool register_successor (successor_type &s) __TBB_override
 
bool remove_successor (successor_type &s) __TBB_override
 
bool try_get (input_type &v) __TBB_override
 Request an item from the sender. More...
 
bool try_reserve (T &v) __TBB_override
 Reserves an item. More...
 
bool try_release () __TBB_override
 Releases the reserved item. More...
 
bool try_consume () __TBB_override
 Consumes the reserved item. More...
 
bool is_valid ()
 
void clear ()
 
- Public Member Functions inherited from tbb::flow::interface11::graph_node
 graph_node (graph &g)
 
virtual ~graph_node ()
 
- 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 Member Functions

tasktry_put_task (const T &v) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::overwrite_node< T >
tasktry_put_task_impl (const input_type &v)
 
graphgraph_reference () const __TBB_override
 
void reset_receiver (reset_flags) __TBB_override
 put receiver back in initial state More...
 
void reset_node (reset_flags f) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::receiver< T >
virtual bool is_continue_receiver ()
 

Friends

template<typename R , typename B >
class run_and_put_task
 
template<typename X , typename Y >
class internal::broadcast_cache
 
template<typename X , typename Y >
class internal::round_robin_cache
 

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 Attributes inherited from tbb::flow::interface11::overwrite_node< T >
spin_mutex my_mutex
 
internal::broadcast_cache< input_type, null_rw_mutexmy_successors
 
input_type my_buffer
 
bool my_buffer_is_valid
 
- Protected Attributes inherited from tbb::flow::interface11::graph_node
graphmy_graph
 
graph_nodenext
 
graph_nodeprev
 

Detailed Description

template<typename T>
class tbb::flow::interface11::write_once_node< T >

Definition at line 4614 of file flow_graph.h.

Member Typedef Documentation

◆ base_type

template<typename T >
typedef overwrite_node<T> tbb::flow::interface11::write_once_node< T >::base_type

Definition at line 4618 of file flow_graph.h.

◆ input_type

template<typename T >
typedef T tbb::flow::interface11::write_once_node< T >::input_type

Definition at line 4616 of file flow_graph.h.

◆ output_type

template<typename T >
typedef T tbb::flow::interface11::write_once_node< T >::output_type

Definition at line 4617 of file flow_graph.h.

◆ predecessor_type

Definition at line 4619 of file flow_graph.h.

◆ successor_type

Definition at line 4620 of file flow_graph.h.

Constructor & Destructor Documentation

◆ write_once_node() [1/2]

template<typename T >
__TBB_NOINLINE_SYM tbb::flow::interface11::write_once_node< T >::write_once_node ( graph g)
inlineexplicit

Constructor.

Definition at line 4623 of file flow_graph.h.

4623  : base_type(g) {
4624  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_WRITE_ONCE_NODE, &(this->my_graph),
4625  static_cast<receiver<input_type> *>(this),
4626  static_cast<sender<output_type> *>(this) );
4627  }

References CODEPTR, and tbb::internal::fgt_node().

Here is the call graph for this function:

◆ write_once_node() [2/2]

template<typename T >
__TBB_NOINLINE_SYM tbb::flow::interface11::write_once_node< T >::write_once_node ( const write_once_node< T > &  src)
inline

Copy constructor: call base class copy constructor.

Definition at line 4637 of file flow_graph.h.

4637  : base_type(src) {
4638  tbb::internal::fgt_node( CODEPTR(), tbb::internal::FLOW_WRITE_ONCE_NODE, &(this->my_graph),
4639  static_cast<receiver<input_type> *>(this),
4640  static_cast<sender<output_type> *>(this) );
4641  }

References CODEPTR, and tbb::internal::fgt_node().

Here is the call graph for this function:

Member Function Documentation

◆ try_put_task()

template<typename T >
task* tbb::flow::interface11::write_once_node< T >::try_put_task ( const T &  v)
inlineprotectedvirtual

Reimplemented from tbb::flow::interface11::overwrite_node< T >.

Definition at line 4653 of file flow_graph.h.

4653  {
4654  spin_mutex::scoped_lock l( this->my_mutex );
4655  return this->my_buffer_is_valid ? NULL : this->try_put_task_impl(v);
4656  }

Friends And Related Function Documentation

◆ internal::broadcast_cache

template<typename T >
template<typename X , typename Y >
friend class internal::broadcast_cache
friend

Definition at line 4651 of file flow_graph.h.

◆ internal::round_robin_cache

template<typename T >
template<typename X , typename Y >
friend class internal::round_robin_cache
friend

Definition at line 4652 of file flow_graph.h.

◆ run_and_put_task

template<typename T >
template<typename R , typename B >
friend class run_and_put_task
friend

Definition at line 4650 of file flow_graph.h.


The documentation for this class was generated from the following file:
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
tbb::flow::interface11::overwrite_node::my_buffer_is_valid
bool my_buffer_is_valid
Definition: flow_graph.h:4602
tbb::spin_mutex::scoped_lock
friend class scoped_lock
Definition: spin_mutex.h:179
tbb::flow::interface11::overwrite_node::try_put_task_impl
task * try_put_task_impl(const input_type &v)
Definition: flow_graph.h:4567
tbb::flow::interface11::write_once_node::base_type
overwrite_node< T > base_type
Definition: flow_graph.h:4618
tbb::flow::interface11::overwrite_node::my_mutex
spin_mutex my_mutex
Definition: flow_graph.h:4596
tbb::internal::fgt_node
static void fgt_node(void *, string_index, void *, void *)
Definition: _flow_graph_trace_impl.h:326

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.