Intel(R) Threading Building Blocks Doxygen Documentation  version 4.2.3
tbb::interface6::internal::concrete_filter< T, void, Body > Class Template Reference

#include <pipeline.h>

Inheritance diagram for tbb::interface6::internal::concrete_filter< T, void, Body >:
Collaboration diagram for tbb::interface6::internal::concrete_filter< T, void, Body >:

Public Member Functions

 concrete_filter (tbb::filter::mode filter_mode, const Body &body)
 
- Public Member Functions inherited from tbb::filter
bool is_serial () const
 True if filter is serial. More...
 
bool is_ordered () const
 True if filter must receive stream in order. More...
 
bool is_bound () const
 True if filter is thread-bound. More...
 
bool object_may_be_null ()
 true if an input filter can emit null More...
 
virtual __TBB_EXPORTED_METHOD ~filter ()
 Destroy filter. More...
 

Private Types

typedef token_helper< T, use_allocator< T >::valuet_helper
 
typedef t_helper::pointer t_pointer
 

Private Member Functions

voidoperator() (void *input) __TBB_override
 Operate on an item from the input stream, and return item for output stream. More...
 
void finalize (void *input) __TBB_override
 Destroys item if pipeline was cancelled. More...
 

Private Attributes

const Body & my_body
 

Additional Inherited Members

- Public Types inherited from tbb::filter
enum  mode { parallel = current_version | filter_is_out_of_order, serial_in_order = current_version | filter_is_serial, serial_out_of_order = current_version | filter_is_serial | filter_is_out_of_order, serial = serial_in_order }
 
- Protected Member Functions inherited from tbb::filter
 filter (bool is_serial_)
 
 filter (mode filter_mode)
 
void __TBB_EXPORTED_METHOD set_end_of_input ()
 
- Static Protected Attributes inherited from tbb::filter
static const unsigned char filter_is_serial = 0x1
 The lowest bit 0 is for parallel vs. serial. More...
 
static const unsigned char filter_is_out_of_order = 0x1<<4
 4th bit distinguishes ordered vs unordered filters. More...
 
static const unsigned char filter_is_bound = 0x1<<5
 5th bit distinguishes thread-bound and regular filters. More...
 
static const unsigned char filter_may_emit_null = 0x1<<6
 6th bit marks input filters emitting small objects More...
 
static const unsigned char exact_exception_propagation
 7th bit defines exception propagation mode expected by the application. More...
 
static const unsigned char current_version = __TBB_PIPELINE_VERSION(5)
 
static const unsigned char version_mask = 0x7<<1
 

Detailed Description

template<typename T, typename Body>
class tbb::interface6::internal::concrete_filter< T, void, Body >

Definition at line 472 of file pipeline.h.

Member Typedef Documentation

◆ t_helper

template<typename T , typename Body >
typedef token_helper<T, use_allocator<T>::value> tbb::interface6::internal::concrete_filter< T, void, Body >::t_helper
private

Definition at line 474 of file pipeline.h.

◆ t_pointer

template<typename T , typename Body >
typedef t_helper::pointer tbb::interface6::internal::concrete_filter< T, void, Body >::t_pointer
private

Definition at line 475 of file pipeline.h.

Constructor & Destructor Documentation

◆ concrete_filter()

template<typename T , typename Body >
tbb::interface6::internal::concrete_filter< T, void, Body >::concrete_filter ( tbb::filter::mode  filter_mode,
const Body &  body 
)
inline

Definition at line 489 of file pipeline.h.

489 : filter(filter_mode), my_body(body) {}

Member Function Documentation

◆ finalize()

template<typename T , typename Body >
void tbb::interface6::internal::concrete_filter< T, void, Body >::finalize ( void )
inlineprivatevirtual

Destroys item if pipeline was cancelled.

Required to prevent memory leaks. Note it can be called concurrently even for serial filters.

Reimplemented from tbb::filter.

Definition at line 483 of file pipeline.h.

483  {
484  t_pointer temp_input = t_helper::cast_from_void_ptr(input);
485  t_helper::destroy_token(temp_input);
486  }

◆ operator()()

template<typename T , typename Body >
void* tbb::interface6::internal::concrete_filter< T, void, Body >::operator() ( void item)
inlineprivatevirtual

Operate on an item from the input stream, and return item for output stream.

Returns NULL if filter is a sink.

Implements tbb::filter.

Definition at line 477 of file pipeline.h.

477  {
478  t_pointer temp_input = t_helper::cast_from_void_ptr(input);
479  my_body(tbb::internal::move(t_helper::token(temp_input)));
480  t_helper::destroy_token(temp_input);
481  return NULL;
482  }

References tbb::move(), and tbb::interface6::internal::concrete_filter< T, U, Body >::my_body.

Here is the call graph for this function:

Member Data Documentation

◆ my_body

template<typename T , typename Body >
const Body& tbb::interface6::internal::concrete_filter< T, void, Body >::my_body
private

Definition at line 473 of file pipeline.h.


The documentation for this class was generated from the following file:
tbb::interface6::internal::concrete_filter< T, void, Body >::t_pointer
t_helper::pointer t_pointer
Definition: pipeline.h:475
tbb::interface6::internal::concrete_filter< T, void, Body >::my_body
const Body & my_body
Definition: pipeline.h:473
tbb::move
void move(tbb_thread &t1, tbb_thread &t2)
Definition: tbb_thread.h:319
tbb::filter::filter
filter(bool is_serial_)
Definition: pipeline.h:105

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.