tbb::task_scheduler_init Class Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Files

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
tbb::task_scheduler_init Class Reference
Task Scheduling

Class delimiting the scope of task scheduler activity. More...

`#include <task_scheduler_init.h>`

Inheritance diagram for tbb::task_scheduler_init:

## Public Member Functions
void __TBB_EXPORTED_METHOD | initialize (int number_of_threads=automatic)
| Ensure that scheduler exists for this thread. More...
void __TBB_EXPORTED_METHOD | initialize (int number_of_threads, stack_size_type thread_stack_size)
| The overloaded method with stack size parameter. More...
void __TBB_EXPORTED_METHOD | terminate ()
| Inverse of method initialize.
void | blocking_terminate ()
| terminate() that waits for worker threads termination. Throws exception on error.
bool | blocking_terminate (const std::nothrow_t &) __TBB_NOEXCEPT(true)
| terminate() that waits for worker threads termination. Returns false on error.
| task_scheduler_init (int number_of_threads=automatic, stack_size_type thread_stack_size=0)
| Shorthand for default constructor followed by call to initialize(number_of_threads).
| ~task_scheduler_init ()
| Destroy scheduler for this thread if thread has no other live task_scheduler_inits.
bool | is_active () const
| Returns true if scheduler is active (initialized); false otherwise.

## Static Public Member Functions
static int __TBB_EXPORTED_FUNC | default_num_threads ()
| Returns the number of threads TBB scheduler would create if initialized by default. More...

## Static Public Attributes
static const int | automatic = -1
| Typedef for number of threads that is automatic.
static const int | deferred = -2
| Argument to initialize() or constructor that causes initialization to be deferred.

## Detailed Description

Class delimiting the scope of task scheduler activity.

A thread can construct a task_scheduler_init object and keep it alive while it uses TBB's tasking subsystem (including parallel algorithms).

This class allows to customize properties of the TBB task pool to some extent. For example it can limit concurrency level of parallel work initiated by the given thread. It also can be used to specify stack size of the TBB worker threads, though this setting is not effective if the thread pool has already been created.

If a parallel construct is used without task_scheduler_init object previously created, the scheduler will be initialized automatically with default settings, and will persist until this thread exits. Default concurrency level is defined as described in task_scheduler_init::initialize().

## Member Function Documentation

static int __TBB_EXPORTED_FUNC tbb::task_scheduler_init::default_num_threads | ( | ) |  |
| static

Returns the number of threads TBB scheduler would create if initialized by default.

Result returned by this method does not depend on whether the scheduler has already been initialized.

Because tbb 2.0 does not support blocking tasks yet, you may use this method to boost the number of threads in the tbb's internal pool, if your tasks are doing I/O operations. The optimal number of additional threads depends on how much time your tasks spend in the blocked state.

Before TBB 3.0 U4 this method returned the number of logical CPU in the system. Currently on Windows, Linux and FreeBSD it returns the number of logical CPUs available to the current process in accordance with its affinity mask.

NOTE: The return value of this method never changes after its first invocation. This means that changes in the process affinity mask that took place after this method was first invoked will not affect the number of worker threads in the TBB worker threads pool.

void __TBB_EXPORTED_METHOD tbb::task_scheduler_init::initialize | ( | int | number_of_threads = `automatic`) |  |

Ensure that scheduler exists for this thread.

A value of -1 lets TBB decide on the number of threads, which is usually maximal hardware concurrency for this process, that is the number of logical CPUs on the machine (possibly limited by the processor affinity mask of this process (Windows) or of this thread (Linux, FreeBSD). It is preferable option for production code because it helps to avoid nasty surprises when several TBB based components run side-by-side or in a nested fashion inside the same process.

The number_of_threads is ignored if any other task_scheduler_inits currently exist. A thread may construct multiple task_scheduler_inits. Doing so does no harm because the underlying scheduler is reference counted.

Referenced by task_scheduler_init().

void __TBB_EXPORTED_METHOD tbb::task_scheduler_init::initialize | ( | int | number_of_threads,
|  | stack_size_type | thread_stack_size
| ) |  |

The overloaded method with stack size parameter.

Overloading is necessary to preserve ABI compatibility

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

- task_scheduler_init.h

Copyright © 2005-2017 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.