cancellation_token_source, classe
La classe cancellation_token_source représente la capacité d'annulation d'une opération annulable.
Syntaxe
class cancellation_token_source;
Membres
Constructeurs publics
| Nom | Description |
|---|---|
| cancellation_token_source | Surcharge. Construit un nouveau cancellation_token_source. La source peut être utilisée pour signaler l'annulation d'une opération annulable. |
| ~cancellation_token_source Destructeur |
Méthodes publiques
| Nom | Description |
|---|---|
| cancel | Annule le jeton. N'importe quel task_group, structured_task_group ou task qui utilise le jeton sera annulé lors de cet appel et lèvera une exception au point d'interruption suivant. |
| create_linked_source | Surcharge. Crée une classe cancellation_token_source qui est annulée lorsque le jeton fourni est annulé. |
| get_token | Retourne un jeton d'annulation associé à cette source. Le jeton retourné peut être interrogé pour l'annulation ou fournir un rappel si et quand l'annulation se produit. |
Opérateurs publics
| Nom | Description |
|---|---|
| operator!= | |
| operator= | |
| operator== |
Hiérarchie d'héritage
cancellation_token_source
Spécifications
En-tête : pplcancellation_token.h
Espace de noms : concurrency
~cancellation_token_source
~cancellation_token_source();
cancel
Annule le jeton. N'importe quel task_group, structured_task_group ou task qui utilise le jeton sera annulé lors de cet appel et lèvera une exception au point d'interruption suivant.
void cancel() const;
cancellation_token_source
Construit un nouveau cancellation_token_source. La source peut être utilisée pour signaler l'annulation d'une opération annulable.
cancellation_token_source();
cancellation_token_source(const cancellation_token_source& _Src);
cancellation_token_source(cancellation_token_source&& _Src);
Paramètres
_Src
Objet à copier ou déplacer.
create_linked_source
Crée une classe cancellation_token_source qui est annulée lorsque le jeton fourni est annulé.
static cancellation_token_source create_linked_source(
cancellation_token& _Src);
template<typename _Iter>
static cancellation_token_source create_linked_source(_Iter _Begin, _Iter _End);
Paramètres
_Iter
Type d’itérateur.
_Src
Jeton dont l'annulation provoque l'annulation de la source du jeton retourné. Notez que la source du jeton retourné peut également être annulée indépendamment de la source contenue dans ce paramètre.
_Commencer
Itérateur de bibliothèque standard C++ correspondant au début de la plage de jetons à écouter pour l’annulation.
_Fin
Itérateur de bibliothèque standard C++ correspondant à la fin de la plage de jetons à écouter pour l’annulation.
Valeur de retour
cancellation_token_source qui est annulée lorsque le jeton fourni par le paramètre _Src est annulé.
get_token
Retourne un jeton d'annulation associé à cette source. Le jeton retourné peut être interrogé pour l'annulation ou fournir un rappel si et quand l'annulation se produit.
cancellation_token get_token() const;
Valeur de retour
Jeton d'annulation associé à cette source.
operator!=
bool operator!= (const cancellation_token_source& _Src) const;
Paramètres
_Src
Opérande.
Valeur de retour
opérateur =
cancellation_token_source& operator= (const cancellation_token_source& _Src);
cancellation_token_source& operator= (cancellation_token_source&& _Src);
Paramètres
_Src
Opérande.
Valeur de retour
operator==
bool operator== (const cancellation_token_source& _Src) const;
Paramètres
_Src
Opérande.