-
Notifications
You must be signed in to change notification settings - Fork 109
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update task_scheduler_handle_cls.rst
Fix formatting
- Loading branch information
1 parent
83e1230
commit d9bf6cc
Showing
4 changed files
with
84 additions
and
52 deletions.
There are no files selected for viewing
64 changes: 64 additions & 0 deletions
64
source/elements/oneTBB/source/deprecated/task_arena_attach_tag.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
.. SPDX-FileCopyrightText: 2019-2020 Intel Corporation | ||
.. | ||
.. SPDX-License-Identifier: CC-BY-4.0 | ||
================== | ||
task_arena::attach | ||
================== | ||
**[deprecated.task_arena_attach_tag]** | ||
|
||
.. caution:: | ||
|
||
Deprecated in oneTBB Specification 1.1 | ||
|
||
A set of methods for constructing a task_arena with attach. | ||
|
||
.. code:: cpp | ||
// Defined in header <tbb/task_arena.h> | ||
namespace tbb { | ||
class task_arena { | ||
public: | ||
// ... | ||
struct attach {}; | ||
explicit task_arena(task_arena::attach); | ||
void initialize(task_arena::attach); | ||
// ... | ||
}; | ||
} // namespace tbb | ||
Member types and constants | ||
-------------------------- | ||
|
||
.. cpp:struct:: attach | ||
|
||
A tag for constructing a task_arena with attach. | ||
|
||
Member functions | ||
---------------- | ||
|
||
.. cpp:function:: explicit task_arena(task_arena::attach) | ||
|
||
Creates an instance of ``task_arena`` that is connected to the internal task arena representation currently used by the calling thread. | ||
If no such arena exists yet, creates a ``task_arena`` with default parameters. | ||
|
||
.. note:: | ||
|
||
Unlike other constructors, this one automatically initializes | ||
the new ``task_arena`` when connecting to an already existing arena. | ||
|
||
|
||
.. cpp:function:: void initialize(task_arena::attach) | ||
|
||
If an internal task arena representation currently used by the calling thread, the method ignores arena | ||
parameters and connects ``task_arena`` to that internal task arena representation. | ||
The method has no effect when called for an already initialized ``task_arena``. | ||
|
||
See also: | ||
|
||
* :doc:`attach <../task_scheduler/attach_tag_type>` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters