Класс cancellation_tokencancellation_token Class

Класс cancellation_token представляет возможность определить, получала ли некоторая операция запрос на отмену.The cancellation_token class represents the ability to determine whether some operation has been requested to cancel. Заданный токен можно связать с task_group, structured_task_group или task для предоставления неявной отмены.A given token can be associated with a task_group, structured_task_group, or task to provide implicit cancellation. Его также можно опрашивать на предмет отмены или зарегистрировать обратный вызов для той ситуации, когда отменяется связанный cancellation_token_source.It can also be polled for cancellation or have a callback registered for if and when the associated cancellation_token_source is canceled.

СинтаксисSyntax

class cancellation_token;

ЧленыMembers

Открытые конструкторыPublic Constructors

nameName ОписаниеDescription
cancellation_tokencancellation_token
Деструктор ~ cancellation_token~cancellation_token Destructor

Открытые методыPublic Methods

nameName ОписаниеDescription
deregister_callbackderegister_callback Удаляет обратный вызов, ранее зарегистрированный с помощью метода register на основании объекта cancellation_token_registration, возвращенного во время регистрации.Removes a callback previously registered via the register method based on the cancellation_token_registration object returned at the time of registration.
is_cancelableis_cancelable Возвращает значение, указывающее, может ли этот токен быть отменен или нет.Returns an indication of whether this token can be canceled or not.
is_canceledis_canceled Возвращает значение true , если токен был отменен.Returns true if the token has been canceled.
Нетnone Возвращает токен отмены, который никогда не может подвергаться отмене.Returns a cancellation token which can never be subject to cancellation.
register_callbackregister_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.

Открытые операторыPublic Operators

ИмяName ОписаниеDescription
operator! =operator!=
Оператор =operator=
Оператор = =operator==

Иерархия наследованияInheritance Hierarchy

cancellation_token

ТребованияRequirements

Заголовок: pplcancellation_token. hHeader: pplcancellation_token.h

Пространство имен: параллелизмNamespace: concurrency

~ cancellation_token~cancellation_token

~cancellation_token();

cancellation_tokencancellation_token

cancellation_token(const cancellation_token& _Src);

cancellation_token(cancellation_token&& _Src);

ПараметрыParameters

_Src_Src
Копируемый или перемещаемый cancellation_token.The cancellation_token to be copied or moved.

deregister_callbackderegister_callback

Удаляет обратный вызов, ранее зарегистрированный с помощью метода register на основании объекта cancellation_token_registration, возвращенного во время регистрации.Removes a callback previously registered via the register method based on the cancellation_token_registration object returned at the time of registration.

void deregister_callback(const cancellation_token_registration& _Registration) const;

ПараметрыParameters

_Registration_Registration
Объект cancellation_token_registration, соответствующий обратному вызову, регистрацию которого требуется отменить.The cancellation_token_registration object corresponding to the callback to be deregistered. Этот токен должен быть предварительно возвращен из вызова метода register.This token must have been previously returned from a call to the register method.

is_cancelableis_cancelable

Возвращает значение, указывающее, может ли этот токен быть отменен или нет.Returns an indication of whether this token can be canceled or not.

bool is_cancelable() const;

Возвращаемое значениеReturn Value

Индикация того, может ли этот токен быть отменен.An indication of whether this token can be canceled or not.

is_canceledis_canceled

Возвращает значение true , если токен был отменен.Returns true if the token has been canceled.

bool is_canceled() const;

Возвращаемое значениеReturn Value

Значение true , если токен был отменен; в противном случае — значение false .The value true if the token has been canceled; otherwise, the value false.

Nonenone

Возвращает токен отмены, который никогда не может подвергаться отмене.Returns a cancellation token which can never be subject to cancellation.

static cancellation_token none();

Возвращаемое значениеReturn Value

Токен отмены, который невозможно отменить.A cancellation token that cannot be canceled.

operator! =operator!=

bool operator!= (const cancellation_token& _Src) const;

ПараметрыParameters

_Src_Src
Сравниваемый шаблон cancellation_token.The cancellation_token to compare.

Возвращаемое значениеReturn Value

Оператор =operator=

cancellation_token& operator= (const cancellation_token& _Src);

cancellation_token& operator= (cancellation_token&& _Src);

ПараметрыParameters

_Src_Src
Объект cancellation_token для назначения.The cancellation_token to assign.

Возвращаемое значениеReturn Value

Оператор = =operator==

bool operator== (const cancellation_token& _Src) const;

ПараметрыParameters

_Src_Src
Сравниваемый шаблон cancellation_token.The cancellation_token to compare.

Возвращаемое значениеReturn Value

register_callbackregister_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.

template<typename _Function>
::Concurrency::cancellation_token_registration register_callback(const _Function& _Func) const;

ПараметрыParameters

_Function_Function
Тип объекта функции, вызываемого при отмене этого cancellation_token.The type of the function object that will be called back when this cancellation_token is canceled.

_Func_Func
Объект функции, вызываемый при отмене этого cancellation_token.The function object that will be called back when this cancellation_token is canceled.

Возвращаемое значениеReturn Value

Объект cancellation_token_registration, который можно использовать в методе deregister для отмены регистрации ранее зарегистрированного обратного вызова и предотвращения его выполнения.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. Метод вызовет исключение invalid_operation , если оно вызывается для cancellation_token объекта, созданного с помощью метода cancellation_token:: None .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.

См. также разделSee also

Пространство имен Concurrencyconcurrency Namespace