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

Inheritance diagram for internal::function_output< Output >:
Collaboration diagram for 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 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_node_impl.h.

Member Typedef Documentation

◆ broadcast_cache_type

template<typename Output >
typedef broadcast_cache<output_type> internal::function_output< Output >::broadcast_cache_type

Definition at line 789 of file _flow_graph_node_impl.h.

◆ output_type

template<typename Output >
typedef Output internal::function_output< Output >::output_type

Definition at line 787 of file _flow_graph_node_impl.h.

◆ successor_type

template<typename Output >
typedef sender<output_type>::successor_type internal::function_output< Output >::successor_type

Definition at line 788 of file _flow_graph_node_impl.h.

Constructor & Destructor Documentation

◆ function_output() [1/2]

template<typename Output >
internal::function_output< Output >::function_output ( )
inline

Definition at line 795 of file _flow_graph_node_impl.h.

795 { my_successors.set_owner(this); }
broadcast_cache_type my_successors
void set_owner(owner_type *owner)

References internal::function_output< Output >::my_successors, and internal::successor_cache< T, M >::set_owner().

Here is the call graph for this function:

◆ function_output() [2/2]

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

Definition at line 796 of file _flow_graph_node_impl.h.

796  : sender<output_type>() {
797  my_successors.set_owner(this);
798  }
broadcast_cache_type my_successors
void set_owner(owner_type *owner)

References internal::function_output< Output >::my_successors, and internal::successor_cache< T, M >::set_owner().

Here is the call graph for this function:

Member Function Documentation

◆ register_successor()

template<typename Output >
bool 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_node_impl.h.

801  {
803  return true;
804  }
void register_successor(successor_type &r)
broadcast_cache_type & successors()

References internal::successor_cache< T, M >::register_successor(), and internal::function_output< Output >::successors().

Here is the call graph for this function:

◆ remove_successor()

template<typename Output >
bool 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_node_impl.h.

807  {
809  return true;
810  }
broadcast_cache_type & successors()
void remove_successor(successor_type &r)

References internal::successor_cache< T, M >::remove_successor(), and internal::function_output< Output >::successors().

Here is the call graph for this function:

◆ successors()

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

◆ try_put_task()

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

Definition at line 841 of file _flow_graph_node_impl.h.

841  { // not a virtual method in this class
842  return my_successors.try_put_task(i);
843  }
broadcast_cache_type my_successors
task * try_put_task(const T &t) __TBB_override

References internal::function_output< Output >::my_successors, and internal::broadcast_cache< T, M >::try_put_task().

Here is the call graph for this function:

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