Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface10::internal::function_output< Output > Class Template Reference

Implements methods for both executable and function nodes that puts Output to its successors. More...

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::internal::function_output< Output >:
Collaboration diagram for tbb::flow::interface10::internal::function_output< Output >:

Public Types

typedef Output output_type
 
typedef sender< output_type >::successor_type successor_type
 
typedef broadcast_cache< output_typebroadcast_cache_type
 
- Public Types inherited from tbb::flow::interface10::sender< Output >
typedef Output output_type
 The output type of this sender. More...
 
typedef internal::async_helpers< Output >::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

 function_output ()
 
 function_output (const function_output &)
 
bool register_successor (successor_type &r) __TBB_override
 Adds a new successor to this node. More...
 
bool remove_successor (successor_type &r) __TBB_override
 Removes a successor from this node. More...
 
tasktry_put_task (const output_type &i)
 
broadcast_cache_typesuccessors ()
 
- Public Member Functions inherited from tbb::flow::interface10::sender< Output >
virtual bool try_get (Output &)
 Request an item from the sender. More...
 
virtual bool try_reserve (Output &)
 Reserves an item in the sender. More...
 
- Public Member Functions inherited from tbb::flow::interface10::internal::untyped_sender
virtual ~untyped_sender ()
 
virtual bool try_release ()
 Releases the reserved item. More...
 
virtual bool try_consume ()
 Consumes the reserved item. More...
 

Protected Attributes

broadcast_cache_type my_successors
 

Friends

template<int N>
struct clear_element
 

Additional Inherited Members

- Protected Member Functions inherited from tbb::flow::interface10::sender< Output >
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 Output>
class tbb::flow::interface10::internal::function_output< Output >

Implements methods for both executable and function nodes that puts Output to its successors.

Definition at line 783 of file flow_graph.h.

Member Typedef Documentation

◆ broadcast_cache_type

Definition at line 789 of file flow_graph.h.

◆ output_type

template<typename Output >
typedef Output tbb::flow::interface10::internal::function_output< Output >::output_type

Definition at line 787 of file flow_graph.h.

◆ successor_type

Definition at line 788 of file flow_graph.h.

Constructor & Destructor Documentation

◆ function_output() [1/2]

template<typename Output >
tbb::flow::interface10::internal::function_output< Output >::function_output ( )
inline

Definition at line 795 of file flow_graph.h.

◆ function_output() [2/2]

template<typename Output >
tbb::flow::interface10::internal::function_output< Output >::function_output ( const function_output< Output > &  )
inline

Definition at line 796 of file flow_graph.h.

Member Function Documentation

◆ register_successor()

template<typename Output >
bool tbb::flow::interface10::internal::function_output< Output >::register_successor ( successor_type r)
inlinevirtual

Adds a new successor to this node.

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

Definition at line 801 of file flow_graph.h.

801  {
802  spin_mutex::scoped_lock lock(nodelist_mutex);
803  __TBB_ASSERT(my_nodes && my_nodes_last, "graph::remove_node: Error: no registered nodes");
804  if (n->prev) n->prev->next = n->next;
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:169
friend class scoped_lock
Definition: spin_mutex.h:180
void const char const char int ITT_FORMAT __itt_group_sync x void const char ITT_FORMAT __itt_group_sync s void ITT_FORMAT __itt_group_sync p void ITT_FORMAT p void ITT_FORMAT p no args __itt_suppress_mode_t unsigned int void size_t ITT_FORMAT d void ITT_FORMAT p void ITT_FORMAT p __itt_model_site __itt_model_site_instance ITT_FORMAT p __itt_model_task __itt_model_task_instance ITT_FORMAT p void * lock

References __TBB_ASSERT, lock, tbb::flow::interface10::graph::my_nodes, tbb::flow::interface10::graph::my_nodes_last, tbb::flow::interface10::graph_node::next, tbb::flow::interface10::graph::nodelist_mutex, and tbb::flow::interface10::graph_node::prev.

◆ remove_successor()

template<typename Output >
bool tbb::flow::interface10::internal::function_output< Output >::remove_successor ( successor_type r)
inlinevirtual

Removes a successor from this node.

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

Definition at line 807 of file flow_graph.h.

◆ successors()

template<typename Output >
broadcast_cache_type& tbb::flow::interface10::internal::function_output< Output >::successors ( )
inline

Definition at line 845 of file flow_graph.h.

845 { return const_iterator(this, false); }

◆ try_put_task()

template<typename Output >
task* tbb::flow::interface10::internal::function_output< Output >::try_put_task ( const output_type i)
inline

Definition at line 841 of file flow_graph.h.

841  { return const_iterator(this, false); }
842 
843 inline graph::const_iterator graph::cbegin() const { return const_iterator(this, true); }
graph_iterator< const graph, const graph_node > const_iterator
const_iterator cbegin() const
start const iterator
Definition: flow_graph.h:843

Friends And Related Function Documentation

◆ clear_element

template<typename Output >
template<int N>
friend struct clear_element
friend

Definition at line 786 of file flow_graph.h.

Member Data Documentation

◆ my_successors


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.