Classe cancellation_token_source
La classe cancellation_token_source rappresenta la possibilità di annullare una determinata operazione annullabile.
Sintassi
class cancellation_token_source;
Membri
Costruttori pubblici
| Nome | Descrizione |
|---|---|
| cancellation_token_source | Con overload. Costruisce un nuovo cancellation_token_source. L'origine può essere utilizzata per contrassegnare l'annullamento di una determinata operazione annullabile. |
| Distruttore ~cancellation_token_source |
Metodi pubblici
| Nome | Descrizione |
|---|---|
| cancel | Annulla il token. Qualsiasi task_group, structured_task_group o task che utilizza il token viene annullato al momento della chiamata e genera un'eccezione nel punto di interruzione successivo. |
| create_linked_source | Con overload. Crea un cancellation_token_source che viene annullato quando il token fornito viene annullato. |
| get_token | Restituisce un token di annullamento associato a questa origine. Il token restituito può essere sottoposto a polling per l'annullamento o fornire un callback se e quando si verifica l'annullamento. |
Operatori pubblici
| Nome | Descrizione |
|---|---|
| operator!= | |
| operator= | |
| operator== |
Gerarchia di ereditarietà
cancellation_token_source
Requisiti
Intestazione: pplcancellation_token.h
Spazio dei nomi: Concurrency
~cancellation_token_source
~cancellation_token_source();
cancel
Annulla il token. Qualsiasi task_group, structured_task_group o task che utilizza il token viene annullato al momento della chiamata e genera un'eccezione nel punto di interruzione successivo.
void cancel() const;
cancellation_token_source
Costruisce un nuovo cancellation_token_source. L'origine può essere utilizzata per contrassegnare l'annullamento di una determinata operazione annullabile.
cancellation_token_source();
cancellation_token_source(const cancellation_token_source& _Src);
cancellation_token_source(cancellation_token_source&& _Src);
Parametri
_Src
Oggetto da copiare o spostare.
create_linked_source
Crea un cancellation_token_source che viene annullato quando il token fornito viene annullato.
static cancellation_token_source create_linked_source(
cancellation_token& _Src);
template<typename _Iter>
static cancellation_token_source create_linked_source(_Iter _Begin, _Iter _End);
Parametri
_Iter
Tipo di iteratore.
_Src
Token il cui annullamento determina l'annullamento del token restituito. Si noti che l'origine del token restituita può anche essere annullata indipendentemente dall'origine contenuta nel parametro.
_Cominciare
Iteratore della libreria standard C++ corrispondente all'inizio dell'intervallo di token di cui attendere l'annullamento.
_Fine
Iteratore della libreria standard C++ corrispondente alla fine dell'intervallo di token di cui attendere l'annullamento.
Valore restituito
cancellation_token_source che viene annullato quando il token fornito dal parametro _Src viene annullato.
get_token
Restituisce un token di annullamento associato a questa origine. Il token restituito può essere sottoposto a polling per l'annullamento o fornire un callback se e quando si verifica l'annullamento.
cancellation_token get_token() const;
Valore restituito
Token di annullamento associato a questa origine.
operator!=
bool operator!= (const cancellation_token_source& _Src) const;
Parametri
_Src
Operando.
Valore restituito
operator=
cancellation_token_source& operator= (const cancellation_token_source& _Src);
cancellation_token_source& operator= (cancellation_token_source&& _Src);
Parametri
_Src
Operando.
Valore restituito
operator==
bool operator== (const cancellation_token_source& _Src) const;
Parametri
_Src
Operando.