Home ⌂Doc Index ◂Up ▴
Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::flow::interface11::internal::key_matching_port< TraitsType > Class Template Reference

#include <flow_graph.h>

Inheritance diagram for tbb::flow::interface11::internal::key_matching_port< TraitsType >:
Collaboration diagram for tbb::flow::interface11::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::interface11::internal::untyped_receiver
typedef untyped_sender predecessor_type
 The predecessor type for this node. More...
 
- Public Types inherited from tbb::flow::interface11::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::interface11::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::interface11::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::interface11::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 () const __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::receiver< TraitsType::T >
virtual tasktry_put_task_wrapper (const void *p, bool is_async) __TBB_override
 
- Protected Member Functions inherited from tbb::flow::interface11::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

- Public Attributes inherited from tbb::flow::interface11::receiver< TraitsType::T >
__TBB_DEPRECATED typedef TraitsType::T input_type
 The input type of this receiver. More...
 
__TBB_DEPRECATED typedef internal::async_helpers< TraitsType::T >::filtered_type filtered_type
 
- Static Public Attributes inherited from tbb::flow::interface11::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::interface11::internal::key_matching_port< TraitsType >

Definition at line 658 of file flow_graph.h.

Member Typedef Documentation

◆ buffer_type

◆ class_type

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

Definition at line 664 of file flow_graph.h.

◆ handler_type

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

Definition at line 705 of file flow_graph.h.

◆ hash_compare_type

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

Definition at line 670 of file flow_graph.h.

◆ input_type

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

Definition at line 665 of file flow_graph.h.

◆ key_type

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

Definition at line 666 of file flow_graph.h.

◆ noref_key_type

Definition at line 667 of file flow_graph.h.

◆ predecessor_type

Definition at line 668 of file flow_graph.h.

◆ traits

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

Definition at line 663 of file flow_graph.h.

◆ type_to_key_func_type

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

Definition at line 669 of file flow_graph.h.

Member Enumeration Documentation

◆ op_type

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

Definition at line 679 of file flow_graph.h.

682  }
683 
static tbb::task *const SUCCESSFULLY_ENQUEUED

Constructor & Destructor Documentation

◆ key_matching_port() [1/2]

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

Definition at line 777 of file flow_graph.h.

◆ key_matching_port() [2/2]

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

Definition at line 783 of file flow_graph.h.

786  :
787  my_context(&use_this_context), my_nodes(NULL), my_nodes_last(NULL), my_task_arena(NULL) {

◆ ~key_matching_port()

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

Definition at line 788 of file flow_graph.h.

Member Function Documentation

◆ get_item()

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

Definition at line 798 of file flow_graph.h.

798  {
799  wait_for_all();
800  my_root_task->set_ref_count(0);
801  tbb::task::destroy(*my_root_task);
802  if (own_context) delete my_context;
803  delete my_task_arena;

◆ get_my_key_func()

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

Definition at line 796 of file flow_graph.h.

◆ graph_reference()

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

Implements tbb::flow::interface11::internal::untyped_receiver.

Definition at line 771 of file flow_graph.h.

772  {

◆ handle_operations()

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

Definition at line 709 of file flow_graph.h.

713  { return true; }
714 
715 }; // class continue_receiver
716 
717 } // interfaceX
718 
719 #if __TBB_PREVIEW_MESSAGE_BASED_KEY_MATCHING
720  template <typename K, typename T>
721  K key_from_message( const T &t ) {
722  return t.key();
723  }
724 #endif /* __TBB_PREVIEW_MESSAGE_BASED_KEY_MATCHING */
725 
726  using interface11::sender;
727  using interface11::receiver;
728  using interface11::continue_receiver;
729 } // flow
730 } // tbb
731 
734 
735 namespace tbb {
736 namespace flow {
737 namespace interface11 {
738 
742 #if __TBB_PREVIEW_ASYNC_MSG
744 #endif
745 using namespace internal::graph_policy_namespace;
746 
747 template <typename C, typename N>
748 graph_iterator<C,N>::graph_iterator(C *g, bool begin) : my_graph(g), current_node(NULL)
749 {
750  if (begin) current_node = my_graph->my_nodes;
751  //else it is an end iterator by default
752 }
753 
K key_from_message(const opencl_async_msg< T, Factory > &dmsg)
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
The graph class.

◆ reset_port()

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

Definition at line 835 of file flow_graph.h.

◆ reset_receiver()

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

put receiver back in initial state

Implements tbb::flow::interface11::internal::untyped_receiver.

Definition at line 847 of file flow_graph.h.

851  {
852  tbb::flow::interface11::graph_node *my_p = &(*ii);
853  my_p->reset_node(f);
854  }
The base of all graph nodes.
virtual void reset_node(reset_flags f=rf_reset_protocol)=0

◆ set_join_node_pointer()

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

Definition at line 790 of file flow_graph.h.

◆ set_my_key_func()

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

Definition at line 794 of file flow_graph.h.

◆ try_put_task()

template<class TraitsType >
task* tbb::flow::interface11::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::interface11::receiver< TraitsType::T >.

Definition at line 759 of file flow_graph.h.

761  {
762  return current_node;
763 }
764 
765 template <typename C, typename N>
767  if (current_node) current_node = current_node->next;
768 }
769 

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 706 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 757 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 758 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 756 of file flow_graph.h.

Member Data Documentation

◆ my_aggregator

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

Definition at line 707 of file flow_graph.h.

◆ my_join

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

Definition at line 859 of file flow_graph.h.


The documentation for this class was generated from the following file:

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.