Класс cancellation_token_sourcecancellation_token_source Class

Класс cancellation_token_source представляет возможность отмены некоторой отменяемой операции.The cancellation_token_source class represents the ability to cancel some cancelable operation.

СинтаксисSyntax

class cancellation_token_source;

ЧленыMembers

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

nameName ОписаниеDescription
cancellation_token_sourcecancellation_token_source Перегружен.Overloaded. Конструирует новый объект cancellation_token_source.Constructs a new cancellation_token_source. Источник можно использовать, чтобы сигнализировать об отмене некоторой отменяемой операции.The source can be used to flag cancellation of some cancelable operation.
Деструктор ~ cancellation_token_source~cancellation_token_source Destructor

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

nameName ОписаниеDescription
cancelcancel Отменяет токен.Cancels the token. Любой элемент task_group, structured_task_group или task, который использует этот токен, будет отменен при этом вызове и создаст исключение в следующей точке прерывания.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.
create_linked_sourcecreate_linked_source Перегружен.Overloaded. Создает cancellation_token_source, который отменяется при отмене предоставленного токена.Creates a cancellation_token_source which is canceled when the provided token is canceled.
get_tokenget_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.

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

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

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

cancellation_token_source

ТребованияRequirements

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

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

~ cancellation_token_source~cancellation_token_source

~cancellation_token_source();

Отменаcancel

Отменяет токен.Cancels the token. Любой элемент task_group, structured_task_group или task, который использует этот токен, будет отменен при этом вызове и создаст исключение в следующей точке прерывания.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.

void cancel() const;

cancellation_token_sourcecancellation_token_source

Конструирует новый объект cancellation_token_source.Constructs a new cancellation_token_source. Источник можно использовать, чтобы сигнализировать об отмене некоторой отменяемой операции.The source can be used to flag cancellation of some cancelable operation.

cancellation_token_source();

cancellation_token_source(const cancellation_token_source& _Src);

cancellation_token_source(cancellation_token_source&& _Src);

ПараметрыParameters

_Src_Src
Объект для копирования или перемещения.Object to copy or move.

create_linked_sourcecreate_linked_source

Создает cancellation_token_source, который отменяется при отмене предоставленного токена.Creates a cancellation_token_source which is canceled when the provided token is canceled.

static cancellation_token_source create_linked_source(
    cancellation_token& _Src);

template<typename _Iter>
static cancellation_token_source create_linked_source(_Iter _Begin, _Iter _End);

ПараметрыParameters

_Iter_Iter
Тип итератора.Iterator type.

_Src_Src
Токен, отмена которого приведет к отмене возвращаемого источника токена.A token whose cancellation will cause cancellation of the returned token source. Обратите внимание, что возвращаемый источник токена также можно отменить независимо от источника, содержащегося в этом параметре.Note that the returned token source can also be canceled independently of the source contained in this parameter.

_Begin_Begin
Итератор стандартной библиотеки C++, соответствующий началу диапазона токенов для прослушивания отмены.The C++ Standard Library iterator corresponding to the beginning of the range of tokens to listen for cancellation of.

_End_End
Итератор стандартной библиотеки C++, соответствующий концу диапазона токенов для прослушивания отмены.The C++ Standard Library iterator corresponding to the ending of the range of tokens to listen for cancellation of.

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

cancellation_token_source, который отменяется при отмене токена, предоставляемого параметром _Src.A cancellation_token_source which is canceled when the token provided by the _Src parameter is canceled.

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

cancellation_token get_token() const;

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

Токен отмены, связанный с этим источником.A cancellation token associated with this source.

operator! =operator!=

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

ПараметрыParameters

_Src_Src
Операнд.Operand.

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

Оператор =operator=

cancellation_token_source& operator= (const cancellation_token_source& _Src);

cancellation_token_source& operator= (cancellation_token_source&& _Src);

ПараметрыParameters

_Src_Src
Операнд.Operand.

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

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

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

ПараметрыParameters

_Src_Src
Операнд.Operand.

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

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

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