Skip to content

Commit 8371dff

Browse files
author
mikeblome
committed
f1 keywords for concrt
1 parent 58d10f8 commit 8371dff

File tree

98 files changed

+742
-861
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+742
-861
lines changed

‎docs/parallel/concrt/reference/affinity-partitioner-class.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ ms.technology:
88
- "devlang-cpp"
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
11-
f1_keywords:
12-
- "ppl/concurrency::affinity_partitioner"
11+
f1_keywords: ['affinity_partitioner', 'PPL/concurrency::affinity_partitioner', 'PPL/concurrency::affinity_partitioner::affinity_partitioner']
1312
dev_langs:
1413
- "C++"
1514
helpviewer_keywords:
@@ -49,7 +48,7 @@ class affinity_partitioner;
4948

5049
|Name|Description|
5150
|----------|-----------------|
52-
|[affinity_partitioner Constructor](#ctor)|Constructs an `affinity_partitioner` object.|
51+
|[affinity_partitioner](#ctor)|Constructs an `affinity_partitioner` object.|
5352
|[~affinity_partitioner Destructor](#dtor)|Destroys an `affinity_partitioner` object.|
5453

5554
## Inheritance Hierarchy

‎docs/parallel/concrt/reference/agent-class.md‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ ms.technology:
88
- "devlang-cpp"
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
11-
f1_keywords:
12-
- "agents/concurrency::agent"
11+
f1_keywords: ['agent', 'AGENTS/concurrency::agent', 'AGENTS/concurrency::agent::agent', 'AGENTS/concurrency::agent::cancel', 'AGENTS/concurrency::agent::start', 'AGENTS/concurrency::agent::status', 'AGENTS/concurrency::agent::status_port', 'AGENTS/concurrency::agent::wait', 'AGENTS/concurrency::agent::wait_for_all', 'AGENTS/concurrency::agent::wait_for_one', 'AGENTS/concurrency::agent::done', 'AGENTS/concurrency::agent::run']
1312
dev_langs:
1413
- "C++"
1514
helpviewer_keywords:
@@ -50,27 +49,27 @@ class agent;
5049

5150
|Name|Description|
5251
|----------|-----------------|
53-
|[agent Constructor](#ctor)|Overloaded. Constructs an agent.|
52+
|[agent](#ctor)|Overloaded. Constructs an agent.|
5453
|[~agent Destructor](#dtor)|Destroys the agent.|
5554

5655
### Public Methods
5756

5857
|Name|Description|
5958
|----------|-----------------|
60-
|[cancel Method](#cancel)|Moves an agent from either the `agent_created` or `agent_runnable` states to the `agent_canceled` state.|
61-
|[start Method](#start)|Moves an agent from the `agent_created` state to the `agent_runnable` state, and schedules it for execution.|
62-
|[status Method](#status)|A synchronous source of status information from the agent.|
63-
|[status_port Method](#status_port)|An asynchronous source of status information from the agent.|
64-
|[wait Method](#wait)|Waits for an agent to complete its task.|
65-
|[wait_for_all Method](#wait_for_all)|Waits for all of the specified agents to complete their tasks.|
66-
|[wait_for_one Method](#wait_for_one)|Waits for any one of the specified agents to complete its task.|
59+
|[cancel](#cancel)|Moves an agent from either the `agent_created` or `agent_runnable` states to the `agent_canceled` state.|
60+
|[start](#start)|Moves an agent from the `agent_created` state to the `agent_runnable` state, and schedules it for execution.|
61+
|[status](#status)|A synchronous source of status information from the agent.|
62+
|[status_port](#status_port)|An asynchronous source of status information from the agent.|
63+
|[wait](#wait)|Waits for an agent to complete its task.|
64+
|[wait_for_all](#wait_for_all)|Waits for all of the specified agents to complete their tasks.|
65+
|[wait_for_one](#wait_for_one)|Waits for any one of the specified agents to complete its task.|
6766

6867
### Protected Methods
6968

7069
|Name|Description|
7170
|----------|-----------------|
72-
|[done Method](#done)|Moves an agent into the `agent_done` state, indicating that the agent has completed.|
73-
|[run Method](#run)|Represents the main task of an agent. `run` should be overridden in a derived class, and specifies what the agent should do after it has been started.|
71+
|[done](#done)|Moves an agent into the `agent_done` state, indicating that the agent has completed.|
72+
|[run](#run)|Represents the main task of an agent. `run` should be overridden in a derived class, and specifies what the agent should do after it has been started.|
7473

7574
## Remarks
7675
For more information, see [Asynchronous Agents](../../../parallel/concrt/asynchronous-agents.md).

‎docs/parallel/concrt/reference/auto-partitioner-class.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ ms.technology:
88
- "devlang-cpp"
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
11-
f1_keywords:
12-
- "ppl/concurrency::auto_partitioner"
11+
f1_keywords: ['auto_partitioner', 'PPL/concurrency::auto_partitioner', 'PPL/concurrency::auto_partitioner::auto_partitioner']
1312
dev_langs:
1413
- "C++"
1514
helpviewer_keywords:
@@ -49,7 +48,7 @@ class auto_partitioner;
4948

5049
|Name|Description|
5150
|----------|-----------------|
52-
|[auto_partitioner Constructor](#ctor)|Constructs a `auto_partitioner` object.|
51+
|[auto_partitioner](#ctor)|Constructs a `auto_partitioner` object.|
5352
|[~auto_partitioner Destructor](#dtor)|Destroys a `auto_partitioner` object.|
5453

5554
## Inheritance Hierarchy

‎docs/parallel/concrt/reference/bad-target-class.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ ms.technology:
88
- "devlang-cpp"
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
11-
f1_keywords:
12-
- "concrt/concurrency::bad_target"
11+
f1_keywords: ['bad_target', 'CONCRT/concurrency::bad_target', 'CONCRT/concurrency::bad_target::bad_target']
1312
dev_langs:
1413
- "C++"
1514
helpviewer_keywords:
@@ -49,7 +48,7 @@ class bad_target : public std::exception;
4948

5049
|Name|Description|
5150
|----------|-----------------|
52-
|[bad_target Constructor](#ctor)|Overloaded. Constructs a `bad_target` object.|
51+
|[bad_target](#ctor)|Overloaded. Constructs a `bad_target` object.|
5352

5453
## Remarks
5554
This exception is typically thrown for reasons such as a target attempting to consume a message which is reserved for a different target or releasing a reservation that it does not hold.

‎docs/parallel/concrt/reference/call-class.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ ms.technology:
88
- "devlang-cpp"
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
11-
f1_keywords:
12-
- "concurrency::call"
13-
- "agents/concurrency::call"
11+
f1_keywords: ['call', 'AGENTS/concurrency::call', 'AGENTS/concurrency::call::call', 'AGENTS/concurrency::call::process_input_messages', 'AGENTS/concurrency::call::process_message', 'AGENTS/concurrency::call::propagate_message', 'AGENTS/concurrency::call::send_message', 'AGENTS/concurrency::call::supports_anonymous_source']
1412
dev_langs:
1513
- "C++"
1614
helpviewer_keywords:
@@ -58,18 +56,18 @@ class call : public target_block<multi_link_registry<ISource<T>>>;
5856

5957
|Name|Description|
6058
|----------|-----------------|
61-
|[call Constructor](#ctor)|Overloaded. Constructs a `call` messaging block.|
59+
|[call](#ctor)|Overloaded. Constructs a `call` messaging block.|
6260
|[~call Destructor](#dtor)|Destroys the `call` messaging block.|
6361

6462
### Protected Methods
6563

6664
|Name|Description|
6765
|----------|-----------------|
68-
|[process_input_messages Method](#process_input_messages)|Executes the call function on the input messages.|
69-
|[process_message Method](#process_message)|Processes a message that was accepted by this `call` messaging block.|
70-
|[propagate_message Method](#propagate_message)|Asynchronously passes a message from an `ISource` block to this `call` messaging block. It is invoked by the `propagate` method, when called by a source block.|
71-
|[send_message Method](#send_message)|Synchronously passes a message from an `ISource` block to this `call` messaging block. It is invoked by the `send` method, when called by a source block.|
72-
|[supports_anonymous_source Method](#supports_anonymous_source)|Overrides the `supports_anonymous_source` method to indicate that this block can accept messages offered to it by a source that is not linked. (Overrides [ITarget::supports_anonymous_source](itarget-class.md#supports_anonymous_source).)|
66+
|[process_input_messages](#process_input_messages)|Executes the call function on the input messages.|
67+
|[process_message](#process_message)|Processes a message that was accepted by this `call` messaging block.|
68+
|[propagate_message](#propagate_message)|Asynchronously passes a message from an `ISource` block to this `call` messaging block. It is invoked by the `propagate` method, when called by a source block.|
69+
|[send_message](#send_message)|Synchronously passes a message from an `ISource` block to this `call` messaging block. It is invoked by the `send` method, when called by a source block.|
70+
|[supports_anonymous_source](#supports_anonymous_source)|Overrides the `supports_anonymous_source` method to indicate that this block can accept messages offered to it by a source that is not linked. (Overrides [ITarget::supports_anonymous_source](itarget-class.md#supports_anonymous_source).)|
7371

7472
## Remarks
7573
For more information, see [Asynchronous Message Blocks](../../../parallel/concrt/asynchronous-message-blocks.md).

‎docs/parallel/concrt/reference/cancellation-token-class.md‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ ms.technology:
88
- "devlang-cpp"
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
11-
f1_keywords:
12-
- "pplcancellation_token/concurrency::cancellation_token"
11+
f1_keywords: ['cancellation_token', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token::cancellation_token', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token::deregister_callback', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token::is_cancelable', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token::is_canceled', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token::none', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token::register_callback']
1312
dev_langs:
1413
- "C++"
1514
helpviewer_keywords:
@@ -49,26 +48,26 @@ class cancellation_token;
4948

5049
|Name|Description|
5150
|----------|-----------------|
52-
|[cancellation_token Constructor](#ctor)||
51+
|[cancellation_token](#ctor)||
5352
|[~cancellation_token Destructor](#dtor)||
5453

5554
### Public Methods
5655

5756
|Name|Description|
5857
|----------|-----------------|
59-
|[deregister_callback Method](#deregister_callback)|Removes a callback previously registered via the `register` method based on the `cancellation_token_registration` object returned at the time of registration.|
60-
|[is_cancelable Method](#is_cancelable)|Returns an indication of whether this token can be canceled or not.|
61-
|[is_canceled Method](#is_canceled)|Returns `true` if the token has been canceled.|
62-
|[none Method](#none)|Returns a cancellation token which can never be subject to cancellation.|
63-
|[register_callback Method](#register_callback)|Registers a callback function with the token. If and when the token is canceled, the callback will be made. Note that if the token is already canceled at the point where this method is called, the callback will be made immediately and synchronously.|
58+
|[deregister_callback](#deregister_callback)|Removes a callback previously registered via the `register` method based on the `cancellation_token_registration` object returned at the time of registration.|
59+
|[is_cancelable](#is_cancelable)|Returns an indication of whether this token can be canceled or not.|
60+
|[is_canceled](#is_canceled)|Returns `true` if the token has been canceled.|
61+
|[none](#none)|Returns a cancellation token which can never be subject to cancellation.|
62+
|[register_callback](#register_callback)|Registers a callback function with the token. If and when the token is canceled, the callback will be made. Note that if the token is already canceled at the point where this method is called, the callback will be made immediately and synchronously.|
6463

6564
### Public Operators
6665

6766
|Name|Description|
6867
|----------|-----------------|
69-
|[operator!= Operator](#operator_neq)||
70-
|[operator= Operator](#operator_eq)||
71-
|[operator== Operator](#operator_eq_eq)||
68+
|[operator!=](#operator_neq)||
69+
|[operator=](#operator_eq)||
70+
|[operator==](#operator_eq_eq)||
7271

7372
## Inheritance Hierarchy
7473
`cancellation_token`

‎docs/parallel/concrt/reference/cancellation-token-registration-class.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ ms.technology:
88
- "devlang-cpp"
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
11-
f1_keywords:
12-
- "pplcancellation_token/concurrency::cancellation_token_registration"
11+
f1_keywords: ['cancellation_token_registration', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token_registration', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token_registration::cancellation_token_registration']
1312
dev_langs:
1413
- "C++"
1514
helpviewer_keywords:
@@ -49,16 +48,16 @@ class cancellation_token_registration;
4948

5049
|Name|Description|
5150
|----------|-----------------|
52-
|[cancellation_token_registration Constructor](#ctor)||
51+
|[cancellation_token_registration](#ctor)||
5352
|[~cancellation_token_registration Destructor](#dtor)||
5453

5554
### Public Operators
5655

5756
|Name|Description|
5857
|----------|-----------------|
59-
|[operator!= Operator](#operator_neq)||
60-
|[operator= Operator](#operator_eq)||
61-
|[operator== Operator](#operator_eq_eq)||
58+
|[operator!=](#operator_neq)||
59+
|[operator=](#operator_eq)||
60+
|[operator==](#operator_eq_eq)||
6261

6362
## Inheritance Hierarchy
6463
`cancellation_token_registration`

‎docs/parallel/concrt/reference/cancellation-token-source-class.md‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ ms.technology:
88
- "devlang-cpp"
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
11-
f1_keywords:
12-
- "pplcancellation_token/concurrency::cancellation_token_source"
11+
f1_keywords: ['cancellation_token_source', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token_source', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token_source::cancellation_token_source', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token_source::cancel', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token_source::create_linked_source', 'PPLCANCELLATION_TOKEN/concurrency::cancellation_token_source::get_token']
1312
dev_langs:
1413
- "C++"
1514
helpviewer_keywords:
@@ -49,24 +48,24 @@ class cancellation_token_source;
4948

5049
|Name|Description|
5150
|----------|-----------------|
52-
|[cancellation_token_source Constructor](#ctor)|Overloaded. Constructs a new `cancellation_token_source`. The source can be used to flag cancellation of some cancelable operation.|
51+
|[cancellation_token_source](#ctor)|Overloaded. Constructs a new `cancellation_token_source`. The source can be used to flag cancellation of some cancelable operation.|
5352
|[~cancellation_token_source Destructor](#dtor)||
5453

5554
### Public Methods
5655

5756
|Name|Description|
5857
|----------|-----------------|
59-
|[cancel Method](#cancel)|Cancels the token. Any `task_group`, `structured_task_group`, or `task` which utilizes the token will be canceled upon this call and throw an exception at the next interruption point.|
60-
|[create_linked_source Method](#create_linked_source)|Overloaded. Creates a `cancellation_token_source` which is canceled when the provided token is canceled.|
61-
|[get_token Method](#get_token)|Returns a cancellation token associated with this source. The returned token can be polled for cancellation or provide a callback if and when cancellation occurs.|
58+
|[cancel](#cancel)|Cancels the token. Any `task_group`, `structured_task_group`, or `task` which utilizes the token will be canceled upon this call and throw an exception at the next interruption point.|
59+
|[create_linked_source](#create_linked_source)|Overloaded. Creates a `cancellation_token_source` which is canceled when the provided token is canceled.|
60+
|[get_token](#get_token)|Returns a cancellation token associated with this source. The returned token can be polled for cancellation or provide a callback if and when cancellation occurs.|
6261

6362
### Public Operators
6463

6564
|Name|Description|
6665
|----------|-----------------|
67-
|[operator!= Operator](#operator_neq)||
68-
|[operator= Operator](#operator_eq)||
69-
|[operator== Operator](#operator_eq_eq)||
66+
|[operator!=](#operator_neq)||
67+
|[operator=](#operator_eq)||
68+
|[operator==](#operator_eq_eq)||
7069

7170
## Inheritance Hierarchy
7271
`cancellation_token_source`

‎docs/parallel/concrt/reference/choice-class.md‎

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ ms.technology:
88
- "devlang-cpp"
99
ms.tgt_pltfrm: ""
1010
ms.topic: "article"
11-
f1_keywords:
12-
- "agents/concurrency::choice"
11+
f1_keywords: ['choice', 'AGENTS/concurrency::choice', 'AGENTS/concurrency::choice::choice', 'AGENTS/concurrency::choice::accept', 'AGENTS/concurrency::choice::acquire_ref', 'AGENTS/concurrency::choice::consume', 'AGENTS/concurrency::choice::has_value', 'AGENTS/concurrency::choice::index', 'AGENTS/concurrency::choice::link_target', 'AGENTS/concurrency::choice::release', 'AGENTS/concurrency::choice::release_ref', 'AGENTS/concurrency::choice::reserve', 'AGENTS/concurrency::choice::unlink_target', 'AGENTS/concurrency::choice::unlink_targets', 'AGENTS/concurrency::choice::value']
1312
dev_langs:
1413
- "C++"
1514
helpviewer_keywords:
@@ -62,25 +61,25 @@ class choice: public ISource<size_t>;
6261

6362
|Name|Description|
6463
|----------|-----------------|
65-
|[choice Constructor](#ctor)|Overloaded. Constructs a `choice` messaging block.|
64+
|[choice](#ctor)|Overloaded. Constructs a `choice` messaging block.|
6665
|[~choice Destructor](#dtor)|Destroys the `choice` messaging block.|
6766

6867
### Public Methods
6968

7069
|Name|Description|
7170
|----------|-----------------|
72-
|[accept Method](#accept)|Accepts a message that was offered by this `choice` block, transferring ownership to the caller.|
73-
|[acquire_ref Method](#acquire_ref)|Acquires a reference count on this `choice` messaging block, to prevent deletion.|
74-
|[consume Method](#consume)|Consumes a message previously offered by this `choice` messaging block and successfully reserved by the target, transferring ownership to the caller.|
75-
|[has_value Method](#has_value)|Checks whether this `choice` messaging block has been initialized with a value yet.|
76-
|[index Method](#index)|Returns an index into the `tuple` representing the element selected by the `choice` messaging block.|
77-
|[link_target Method](#link_target)|Links a target block to this `choice` messaging block.|
78-
|[release Method](#release)|Releases a previous successful message reservation.|
79-
|[release_ref Method](#release_ref)|Releases a reference count on this `choice` messaging block.|
80-
|[reserve Method](#reserve)|Reserves a message previously offered by this `choice` messaging block.|
81-
|[unlink_target Method](#unlink_target)|Unlinks a target block from this `choice` messaging block.|
82-
|[unlink_targets Method](#unlink_targets)|Unlinks all targets from this `choice` messaging block. (Overrides [ISource::unlink_targets](isource-class.md#unlink_targets).)|
83-
|[value Method](#value)|Gets the message whose index was selected by the `choice` messaging block.|
71+
|[accept](#accept)|Accepts a message that was offered by this `choice` block, transferring ownership to the caller.|
72+
|[acquire_ref](#acquire_ref)|Acquires a reference count on this `choice` messaging block, to prevent deletion.|
73+
|[consume](#consume)|Consumes a message previously offered by this `choice` messaging block and successfully reserved by the target, transferring ownership to the caller.|
74+
|[has_value](#has_value)|Checks whether this `choice` messaging block has been initialized with a value yet.|
75+
|[index](#index)|Returns an index into the `tuple` representing the element selected by the `choice` messaging block.|
76+
|[link_target](#link_target)|Links a target block to this `choice` messaging block.|
77+
|[release](#release)|Releases a previous successful message reservation.|
78+
|[release_ref](#release_ref)|Releases a reference count on this `choice` messaging block.|
79+
|[reserve](#reserve)|Reserves a message previously offered by this `choice` messaging block.|
80+
|[unlink_target](#unlink_target)|Unlinks a target block from this `choice` messaging block.|
81+
|[unlink_targets](#unlink_targets)|Unlinks all targets from this `choice` messaging block. (Overrides [ISource::unlink_targets](isource-class.md#unlink_targets).)|
82+
|[value](#value)|Gets the message whose index was selected by the `choice` messaging block.|
8483

8584
## Remarks
8685
The choice block ensures that only one of the incoming messages is consumed.

0 commit comments

Comments
 (0)