Класс cancellation_token_source
Класс cancellation_token_source представляет возможность отмены некоторой отменяемой операции.
Синтаксис
class cancellation_token_source;
Участники
Открытые конструкторы
| Имя | Описание |
|---|---|
| cancellation_token_source | Перегружен. Конструирует новый объект cancellation_token_source. Источник можно использовать, чтобы сигнализировать об отмене некоторой отменяемой операции. |
| Деструктор ~cancellation_token_source |
Открытые методы
| Имя | Описание |
|---|---|
| cancel | Отменяет токен. Любой элемент task_group, structured_task_group или task, который использует этот токен, будет отменен при этом вызове и создаст исключение в следующей точке прерывания. |
| create_linked_source | Перегружен. Создает cancellation_token_source, который отменяется при отмене предоставленного токена. |
| get_token | Возвращает токен отмены, связанный с данным источником. Возвращенный токен можно опрашивать на предмет отмены или предоставить обратный вызов, если и когда произойдет отмена. |
Открытые операторы
| Имя | Описание |
|---|---|
| оператор!= | |
| operator= | |
| operator== |
Иерархия наследования
cancellation_token_source
Требования
Заголовок: pplcancellation_token.h
Пространство имен: concurrency
~cancellation_token_source
~cancellation_token_source();
Отмена
Отменяет токен. Любой элемент task_group, structured_task_group или task, который использует этот токен, будет отменен при этом вызове и создаст исключение в следующей точке прерывания.
void cancel() const;
cancellation_token_source
Конструирует новый объект cancellation_token_source. Источник можно использовать, чтобы сигнализировать об отмене некоторой отменяемой операции.
cancellation_token_source();
cancellation_token_source(const cancellation_token_source& _Src);
cancellation_token_source(cancellation_token_source&& _Src);
Параметры
_Src
Объект для копирования или перемещения.
create_linked_source
Создает cancellation_token_source, который отменяется при отмене предоставленного токена.
static cancellation_token_source create_linked_source(
cancellation_token& _Src);
template<typename _Iter>
static cancellation_token_source create_linked_source(_Iter _Begin, _Iter _End);
Параметры
_Трубчатый проход
Тип итератора.
_Src
Токен, отмена которого приведет к отмене возвращаемого источника токена. Обратите внимание, что возвращаемый источник токена также можно отменить независимо от источника, содержащегося в этом параметре.
_Начинать
Итератор стандартной библиотеки C++, соответствующий началу диапазона маркеров для прослушивания отмены.
_Конец
Итератор стандартной библиотеки C++ соответствует окончанию диапазона маркеров для прослушивания отмены.
Возвращаемое значение
cancellation_token_source, который отменяется при отмене токена, предоставляемого параметром _Src.
get_token
Возвращает токен отмены, связанный с данным источником. Возвращенный токен можно опрашивать на предмет отмены или предоставить обратный вызов, если и когда произойдет отмена.
cancellation_token get_token() const;
Возвращаемое значение
Токен отмены, связанный с этим источником.
оператор!=
bool operator!= (const cancellation_token_source& _Src) const;
Параметры
_Src
Операнд.
Возвращаемое значение
operator=
cancellation_token_source& operator= (const cancellation_token_source& _Src);
cancellation_token_source& operator= (cancellation_token_source&& _Src);
Параметры
_Src
Операнд.
Возвращаемое значение
operator==
bool operator== (const cancellation_token_source& _Src) const;
Параметры
_Src
Операнд.