cancellation_token_source — Klasa
Klasa cancellation_token_source
reprezentuje możliwość anulowania niektórych operacji, które można anulować.
Składnia
class cancellation_token_source;
Elementy członkowskie
Konstruktory publiczne
Nazwa/nazwisko | opis |
---|---|
cancellation_token_source | Przeciążone. Tworzy nowy cancellation_token_source element . Źródło może służyć do flagowania anulowania niektórych operacji, które można anulować. |
~cancellation_token_source Destruktor |
Metody publiczne
Nazwa/nazwisko | opis |
---|---|
Anuluj | Anuluje token. Każdy task_group element , structured_task_group lub task , który korzysta z tokenu, zostanie anulowany podczas tego wywołania i zgłosi wyjątek w następnym punkcie przerwy. |
create_linked_source | Przeciążone. Tworzy element cancellation_token_source , który zostanie anulowany po anulowaniu podanego tokenu. |
get_token | Zwraca token anulowania skojarzony z tym źródłem. Zwrócony token można sondować pod kątem anulowania lub podać wywołanie zwrotne, jeśli i kiedy nastąpi anulowanie. |
Operatory publiczne
Nazwa/nazwisko | opis |
---|---|
operator!= | |
operator = | |
operator== |
Hierarchia dziedziczenia
cancellation_token_source
Wymagania
Nagłówek: pplcancellation_token.h
Przestrzeń nazw: współbieżność
~cancellation_token_source
~cancellation_token_source();
Anuluj
Anuluje token. Każdy task_group
element , structured_task_group
lub task
, który korzysta z tokenu, zostanie anulowany podczas tego wywołania i zgłosi wyjątek w następnym punkcie przerwy.
void cancel() const;
cancellation_token_source
Tworzy nowy cancellation_token_source
element . Źródło może służyć do flagowania anulowania niektórych operacji, które można anulować.
cancellation_token_source();
cancellation_token_source(const cancellation_token_source& _Src);
cancellation_token_source(cancellation_token_source&& _Src);
Parametry
_Src
Obiekt do skopiowania lub przeniesienia.
create_linked_source
Tworzy element cancellation_token_source
, który zostanie anulowany po anulowaniu podanego tokenu.
static cancellation_token_source create_linked_source(
cancellation_token& _Src);
template<typename _Iter>
static cancellation_token_source create_linked_source(_Iter _Begin, _Iter _End);
Parametry
_Iter
Typ iteratora.
_Src
Token, którego anulowanie spowoduje anulowanie zwróconego źródła tokenu. Należy pamiętać, że zwrócone źródło tokenu można również anulować niezależnie od źródła zawartego w tym parametrze.
_Zaczynać
Iterator biblioteki standardowej języka C++ odpowiadający początek zakresu tokenów do nasłuchiwania w celu anulowania.
_Koniec
Iterator biblioteki standardowej języka C++ odpowiadający końcowemu zakresowi tokenów do nasłuchiwania w celu anulowania.
Wartość zwracana
Element cancellation_token_source
, który jest anulowany po anulowaniu tokenu dostarczonego _Src
przez parametr .
get_token
Zwraca token anulowania skojarzony z tym źródłem. Zwrócony token można sondować pod kątem anulowania lub podać wywołanie zwrotne, jeśli i kiedy nastąpi anulowanie.
cancellation_token get_token() const;
Wartość zwracana
Token anulowania skojarzony z tym źródłem.
operator!=
bool operator!= (const cancellation_token_source& _Src) const;
Parametry
_Src
Operand.
Wartość zwracana
operator =
cancellation_token_source& operator= (const cancellation_token_source& _Src);
cancellation_token_source& operator= (cancellation_token_source&& _Src);
Parametry
_Src
Operand.
Wartość zwracana
operator==
bool operator== (const cancellation_token_source& _Src) const;
Parametry
_Src
Operand.