cancellation_token – třída
Třída cancellation_token představuje schopnost určit, zda byla některá operace požadována ke zrušení. Daný token může být přidružen k , task_groupstructured_task_groupnebo task poskytnout implicitní zrušení. Můžete se také dotazovat na zrušení nebo mít zaregistrované zpětné volání, pokud a kdy je přidruženo cancellation_token_source zrušeno.
Syntaxe
class cancellation_token;
Členové
Veřejné konstruktory
| Název | Popis |
|---|---|
| cancellation_token | |
| ~cancellation_token Destruktor |
Veřejné metody
| Název | Popis |
|---|---|
| deregister_callback | Odebere zpětné volání dříve zaregistrované prostřednictvím register metody na základě objektu vráceného cancellation_token_registration v době registrace. |
| is_cancelable | Vrátí informaci o tom, jestli je možné tento token zrušit nebo ne. |
| is_canceled | Vrátí true , pokud byl token zrušen. |
| žádné | Vrátí token zrušení, který nemůže být nikdy předmětem zrušení. |
| register_callback | Zaregistruje funkci zpětného volání s tokenem. Pokud a když dojde ke zrušení tokenu, provede se zpětné volání. Všimněte si, že pokud je token již zrušen v okamžiku, kdy je volána tato metoda, bude zpětné volání provedeno okamžitě a synchronně. |
Veřejné operátory
| Název | Popis |
|---|---|
| operator!= | |
| operator= | |
| operator== |
Hierarchie dědičnosti
cancellation_token
Požadavky
Hlavička: pplcancellation_token.h
Namespace: souběžnost
~cancellation_token
~cancellation_token();
cancellation_token
cancellation_token(const cancellation_token& _Src);
cancellation_token(cancellation_token&& _Src);
Parametry
_Src
Cancellation_token, která se má zkopírovat nebo přesunout.
deregister_callback
Odebere zpětné volání dříve zaregistrované prostřednictvím register metody na základě objektu vráceného cancellation_token_registration v době registrace.
void deregister_callback(const cancellation_token_registration& _Registration) const;
Parametry
_Registrace
Objekt cancellation_token_registration odpovídající zpětnému volání, který má být deregistrován. Tento token musel být dříve vrácen z volání metody register .
is_cancelable
Vrátí informaci o tom, jestli je možné tento token zrušit nebo ne.
bool is_cancelable() const;
Návratová hodnota
Údaj o tom, jestli je možné tento token zrušit nebo ne.
is_canceled
Vrátí true , pokud byl token zrušen.
bool is_canceled() const;
Návratová hodnota
Hodnota true , pokud byl token zrušen; jinak hodnota false.
Žádná
Vrátí token zrušení, který nemůže být nikdy předmětem zrušení.
static cancellation_token none();
Návratová hodnota
Token zrušení, který nelze zrušit.
operator!=
bool operator!= (const cancellation_token& _Src) const;
Parametry
_Src
Porovnání cancellation_token .
Návratová hodnota
operator=
cancellation_token& operator= (const cancellation_token& _Src);
cancellation_token& operator= (cancellation_token&& _Src);
Parametry
_Src
Přiřazení cancellation_token
Návratová hodnota
operator==
bool operator== (const cancellation_token& _Src) const;
Parametry
_Src
Porovnání cancellation_token .
Návratová hodnota
register_callback
Zaregistruje funkci zpětného volání s tokenem. Pokud a když dojde ke zrušení tokenu, provede se zpětné volání. Všimněte si, že pokud je token již zrušen v okamžiku, kdy je volána tato metoda, bude zpětné volání provedeno okamžitě a synchronně.
template<typename _Function>
::Concurrency::cancellation_token_registration register_callback(const _Function& _Func) const;
Parametry
_Funkce
Typ objektu funkce, který bude volána zpět při zrušení cancellation_token .
_Func
Objekt funkce, který bude volána zpět při zrušení cancellation_token .
Návratová hodnota
Objekt cancellation_token_registration , který lze použít v deregister metodě k zrušení registrace dříve registrované zpětného volání a zabránit jeho provedení. Metoda vyvolá výjimku invalid_operation , pokud je volána u cancellation_token objektu vytvořeného pomocí metody cancellation_token::none .