The cancellation_token class represents the ability to determine whether some operation has been requested to cancel. A given token can be associated with a task_group, structured_task_group, or task to provide implicit cancellation. It can also be polled for cancellation or have a callback registered for if and when the associated cancellation_token_source is canceled.
More...
#include <pplxcancellation_token.h>
|
|
class | cancellation_token_source |
| |
The cancellation_token class represents the ability to determine whether some operation has been requested to cancel. A given token can be associated with a task_group, structured_task_group, or task to provide implicit cancellation. It can also be polled for cancellation or have a callback registered for if and when the associated cancellation_token_source is canceled.
Removes a callback previously registered via the register method based on the cancellation_token_registration object returned at the time of registration.
- Parameters
-
| _Registration | The cancellation_token_registration object corresponding to the callback to be deregistered. This token must have been previously returned from a call to the register method. |
| bool pplx::cancellation_token::is_cancelable |
( |
| ) |
const |
|
inline |
Returns an indication of whether this token can be canceled or not.
- Returns
- An indication of whether this token can be canceled or not.
| bool pplx::cancellation_token::is_canceled |
( |
| ) |
const |
|
inline |
Returns true if the token has been canceled.
- Returns
- The value
true if the token has been canceled; otherwise, the value false.
Returns a cancellation token which can never be subject to cancellation.
- Returns
- A cancellation token that cannot be canceled.
template<typename _Function >
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.
- Template Parameters
-
| _Function | The type of the function object that will be called back when this cancellation_token is canceled. |
- Parameters
-
| _Func | The function object that will be called back when this cancellation_token is canceled. |
- Returns
- A
cancellation_token_registration object which can be utilized in the deregister method to deregister a previously registered callback and prevent it from being made. The method will throw an invalid_operation exception if it is called on a cancellation_token object that was created using the cancellation_token::none method.
The documentation for this class was generated from the following file:
1.8.10