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

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface10::internal::key_matching_port< TraitsType >:
Collaboration diagram for tbb::flow::interface10::internal::key_matching_port< TraitsType >:

Classes

class  key_matching_port_operation
 

Public Types

typedef TraitsType traits
 
typedef key_matching_port< traitsclass_type
 
typedef TraitsType::T input_type
 
typedef TraitsType::K key_type
 
typedef tbb::internal::strip< key_type >::type noref_key_type
 
typedef receiver< input_type >::predecessor_type predecessor_type
 
typedef TraitsType::TtoK type_to_key_func_type
 
typedef TraitsType::KHash hash_compare_type
 
typedef hash_buffer< key_type, input_type, type_to_key_func_type, hash_compare_typebuffer_type
 
- Public Types inherited from tbb::flow::interface10::receiver< TraitsType::T >
typedef TraitsType::T input_type
 The input type of this receiver. More...
 
typedef internal::async_helpers< TraitsType::T >::filtered_type filtered_type
 
- Public Types inherited from tbb::flow::interface10::internal::untyped_receiver
typedef untyped_sender predecessor_type
 The predecessor type for this node. More...
 
- Public Types inherited from tbb::flow::interface10::internal::hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >
typedef TraitsType::T value_type
 
typedef buffer_element_type< value_type >::type element_type
 
typedef value_typepointer_type
 
typedef element_typelist_array_type
 
typedef list_array_typepointer_array_type
 
typedef tbb::cache_aligned_allocator< typename aligned_pair< TraitsType::T, void * >::type > ::template rebind< list_array_type >::other pointer_array_allocator_type
 
typedef tbb::cache_aligned_allocator< typename aligned_pair< TraitsType::T, void * >::type > ::template rebind< element_type >::other elements_array_allocator
 
typedef tbb::internal::strip< TraitsType::K >::type Knoref
 

Public Member Functions

 key_matching_port ()
 
 key_matching_port (const key_matching_port &)
 
 ~key_matching_port ()
 
void set_join_node_pointer (forwarding_base *join)
 
void set_my_key_func (type_to_key_func_type *f)
 
type_to_key_func_typeget_my_key_func ()
 
bool get_item (input_type &v)
 
void reset_port ()
 
void reset_receiver (reset_flags f) __TBB_override
 put receiver back in initial state More...
 
- Public Member Functions inherited from tbb::flow::interface10::receiver< TraitsType::T >
bool try_put (const typename internal::async_helpers< TraitsType::T >::filtered_type &t)
 Put an item to the receiver. More...
 
bool try_put (const typename internal::async_helpers< TraitsType::T >::async_type &t)
 
- Public Member Functions inherited from tbb::flow::interface10::internal::untyped_receiver
virtual ~untyped_receiver ()
 Destructor. More...
 
template<typename X >
bool try_put (const X &t)
 Put an item to the receiver. More...
 
virtual bool register_predecessor (predecessor_type &)
 Add a predecessor to the node. More...
 
virtual bool remove_predecessor (predecessor_type &)
 Remove a predecessor from the node. More...
 
- Public Member Functions inherited from tbb::flow::interface10::internal::hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >
 hash_buffer ()
 
 ~hash_buffer ()
 
void reset ()
 
void set_key_func (TraitsType::TtoK *vtk)
 
TraitsType::TtoK * get_key_func ()
 
bool insert_with_key (const value_type &v)
 
bool find_ref_with_key (const Knoref &k, pointer_type &v)
 
bool find_with_key (const Knoref &k, value_type &v)
 
void delete_with_key (const Knoref &k)
 

Protected Member Functions

tasktry_put_task (const input_type &v) __TBB_override
 Put item to successor; return task to run the successor if possible. More...
 
graphgraph_reference () __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::receiver< TraitsType::T >
virtual tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface10::internal::untyped_receiver
template<typename X >
tasktry_put_task (const X &t)
 
virtual bool is_continue_receiver ()
 

Private Types

enum  op_type { try__put, get__item, res_port }
 
typedef internal::aggregating_functor< class_type, key_matching_port_operationhandler_type
 

Private Member Functions

void handle_operations (key_matching_port_operation *op_list)
 

Private Attributes

aggregator< handler_type, key_matching_port_operationmy_aggregator
 
matching_forwarding_base< key_type > * my_join
 

Friends

class internal::aggregating_functor< class_type, key_matching_port_operation >
 
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

- Static Public Attributes inherited from tbb::flow::interface10::internal::hash_buffer< TraitsType::K, TraitsType::T, TraitsType::TtoK, TraitsType::KHash >
static const size_t INITIAL_SIZE
 

Detailed Description

template<class TraitsType>
class tbb::flow::interface10::internal::key_matching_port< TraitsType >

Definition at line 650 of file flow_graph.h.

Member Typedef Documentation

◆ buffer_type

◆ class_type

template<class TraitsType >
typedef key_matching_port<traits> tbb::flow::interface10::internal::key_matching_port< TraitsType >::class_type

Definition at line 656 of file flow_graph.h.

◆ handler_type

template<class TraitsType >
typedef internal::aggregating_functor<class_type, key_matching_port_operation> tbb::flow::interface10::internal::key_matching_port< TraitsType >::handler_type
private

Definition at line 697 of file flow_graph.h.

◆ hash_compare_type

template<class TraitsType >
typedef TraitsType::KHash tbb::flow::interface10::internal::key_matching_port< TraitsType >::hash_compare_type

Definition at line 662 of file flow_graph.h.

◆ input_type

template<class TraitsType >
typedef TraitsType::T tbb::flow::interface10::internal::key_matching_port< TraitsType >::input_type

Definition at line 657 of file flow_graph.h.

◆ key_type

template<class TraitsType >
typedef TraitsType::K tbb::flow::interface10::internal::key_matching_port< TraitsType >::key_type

Definition at line 658 of file flow_graph.h.

◆ noref_key_type

Definition at line 659 of file flow_graph.h.

◆ predecessor_type

Definition at line 660 of file flow_graph.h.

◆ traits

template<class TraitsType >
typedef TraitsType tbb::flow::interface10::internal::key_matching_port< TraitsType >::traits

Definition at line 655 of file flow_graph.h.

◆ type_to_key_func_type

template<class TraitsType >
typedef TraitsType::TtoK tbb::flow::interface10::internal::key_matching_port< TraitsType >::type_to_key_func_type

Definition at line 661 of file flow_graph.h.

Member Enumeration Documentation

◆ op_type

template<class TraitsType >
enum tbb::flow::interface10::internal::key_matching_port::op_type
private
Enumerator
try__put 
get__item 
res_port 

Definition at line 671 of file flow_graph.h.

672  {
673 #if TBB_DEPRECATED_FLOW_NODE_EXTRACTION
674  my_built_predecessors.clear();
675 #endif

Constructor & Destructor Documentation

◆ key_matching_port() [1/2]

template<class TraitsType >
tbb::flow::interface10::internal::key_matching_port< TraitsType >::key_matching_port ( )
inline

Definition at line 769 of file flow_graph.h.

◆ key_matching_port() [2/2]

template<class TraitsType >
tbb::flow::interface10::internal::key_matching_port< TraitsType >::key_matching_port ( const key_matching_port< TraitsType > &  )
inline

Definition at line 775 of file flow_graph.h.

◆ ~key_matching_port()

template<class TraitsType >
tbb::flow::interface10::internal::key_matching_port< TraitsType >::~key_matching_port ( )
inline

Definition at line 780 of file flow_graph.h.

780 {

References tbb::flow::interface10::graph::my_root_task.

Member Function Documentation

◆ get_item()

template<class TraitsType >
bool tbb::flow::interface10::internal::key_matching_port< TraitsType >::get_item ( input_type v)
inline

Definition at line 790 of file flow_graph.h.

◆ get_my_key_func()

template<class TraitsType >
type_to_key_func_type* tbb::flow::interface10::internal::key_matching_port< TraitsType >::get_my_key_func ( )
inline

Definition at line 788 of file flow_graph.h.

789 {

◆ graph_reference()

template<class TraitsType >
graph& tbb::flow::interface10::internal::key_matching_port< TraitsType >::graph_reference ( )
inlineprotectedvirtual

Implements tbb::flow::interface10::internal::untyped_receiver.

Definition at line 763 of file flow_graph.h.

765  {

◆ handle_operations()

template<class TraitsType >
void tbb::flow::interface10::internal::key_matching_port< TraitsType >::handle_operations ( key_matching_port_operation op_list)
inlineprivate

Definition at line 701 of file flow_graph.h.

707  {
708 namespace flow {
709 namespace interface10 {
710 
714 #if __TBB_PREVIEW_ASYNC_MSG
716 #endif
717 using namespace internal::graph_policy_namespace;
718 
719 template <typename C, typename N>
720 graph_iterator<C,N>::graph_iterator(C *g, bool begin) : my_graph(g), current_node(NULL)
721 {
722  if (begin) current_node = my_graph->my_nodes;
723  //else it is an end iterator by default
724 }
725 
726 template <typename C, typename N>
727 typename graph_iterator<C,N>::reference graph_iterator<C,N>::operator*() const {
728  __TBB_ASSERT(current_node, "graph_iterator at end");
729  return *operator->();
730 }
731 
732 template <typename C, typename N>
733 typename graph_iterator<C,N>::pointer graph_iterator<C,N>::operator->() const {
734  return current_node;
735 }
736 
737 template <typename C, typename N>
738 void graph_iterator<C,N>::internal_forward() {
739  if (current_node) current_node = current_node->next;
740 }
741 
743 inline graph::graph() : my_nodes(NULL), my_nodes_last(NULL), my_task_arena(NULL) {
744  prepare_task_arena();
745  own_context = true;
#define __TBB_ASSERT(predicate, comment)
No-op version of __TBB_ASSERT.
Definition: tbb_stddef.h:165
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 ITT_FORMAT p void ITT_FORMAT p void size_t ITT_FORMAT d void ITT_FORMAT p const wchar_t ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s const char ITT_FORMAT s no args void ITT_FORMAT p size_t ITT_FORMAT d no args const wchar_t const wchar_t ITT_FORMAT s __itt_heap_function void size_t int ITT_FORMAT d __itt_heap_function void ITT_FORMAT p __itt_heap_function void void size_t int ITT_FORMAT d no args no args unsigned int ITT_FORMAT u const __itt_domain __itt_id ITT_FORMAT lu const __itt_domain __itt_id __itt_id __itt_string_handle ITT_FORMAT p const __itt_domain __itt_id ITT_FORMAT p const __itt_domain __itt_id __itt_timestamp begin

◆ reset_port()

template<class TraitsType >
void tbb::flow::interface10::internal::key_matching_port< TraitsType >::reset_port ( )
inline

Definition at line 827 of file flow_graph.h.

827  {
828  internal::spawn_in_graph_arena(*this, *(*rti));
829  }
830  my_reset_task_list.clear();
831 }
void spawn_in_graph_arena(graph &g, tbb::task &arena_task)
Spawns a task inside graph arena.

References tbb::flow::interface10::internal::spawn_in_graph_arena().

Here is the call graph for this function:

◆ reset_receiver()

template<class TraitsType >
void tbb::flow::interface10::internal::key_matching_port< TraitsType >::reset_receiver ( reset_flags  f)
inlinevirtual

put receiver back in initial state

Implements tbb::flow::interface10::internal::untyped_receiver.

Definition at line 839 of file flow_graph.h.

839  { return const_iterator(this, false); }
840 
841 inline graph::const_iterator graph::cbegin() const { return const_iterator(this, true); }
842 
843 inline graph::const_iterator graph::cend() const { return const_iterator(this, false); }
844 
845 #if TBB_PREVIEW_FLOW_GRAPH_TRACE
846 inline void graph::set_name(const char *name) {
const_iterator cbegin() const
start const iterator
Definition: flow_graph.h:841
graph_iterator< const graph, const graph_node > const_iterator
void const char const char int ITT_FORMAT __itt_group_sync x void const char * name
const_iterator cend() const
end const iterator
Definition: flow_graph.h:843

◆ set_join_node_pointer()

template<class TraitsType >
void tbb::flow::interface10::internal::key_matching_port< TraitsType >::set_join_node_pointer ( forwarding_base join)
inline

Definition at line 782 of file flow_graph.h.

◆ set_my_key_func()

template<class TraitsType >
void tbb::flow::interface10::internal::key_matching_port< TraitsType >::set_my_key_func ( type_to_key_func_type f)
inline

Definition at line 786 of file flow_graph.h.

◆ try_put_task()

template<class TraitsType >
task* tbb::flow::interface10::internal::key_matching_port< TraitsType >::try_put_task ( const input_type t)
inlineprotectedvirtual

Put item to successor; return task to run the successor if possible.

Implements tbb::flow::interface10::receiver< TraitsType::T >.

Definition at line 751 of file flow_graph.h.

755  :
756  my_context(&use_this_context), my_nodes(NULL), my_nodes_last(NULL), my_task_arena(NULL) {
757  prepare_task_arena();
758  own_context = false;
759  my_root_task = (new (task::allocate_root(*my_context)) empty_task);
760  my_root_task->set_ref_count(1);
static internal::allocate_root_proxy allocate_root()
Returns proxy for overloaded new that allocates a root task.
Definition: task.h:633
static void fgt_graph(void *)

Friends And Related Function Documentation

◆ internal::aggregating_functor< class_type, key_matching_port_operation >

template<class TraitsType >
friend class internal::aggregating_functor< class_type, key_matching_port_operation >
friend

Definition at line 698 of file flow_graph.h.

◆ internal::broadcast_cache

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

Definition at line 749 of file flow_graph.h.

◆ internal::round_robin_cache

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

Definition at line 750 of file flow_graph.h.

◆ run_and_put_task

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

Definition at line 748 of file flow_graph.h.

Member Data Documentation

◆ my_aggregator

template<class TraitsType >
aggregator<handler_type, key_matching_port_operation> tbb::flow::interface10::internal::key_matching_port< TraitsType >::my_aggregator
private

Definition at line 699 of file flow_graph.h.

◆ my_join

template<class TraitsType >
matching_forwarding_base<key_type>* tbb::flow::interface10::internal::key_matching_port< TraitsType >::my_join
private

Definition at line 851 of file flow_graph.h.


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.