Share via


cancellation_token_source (Clase)

La clase cancellation_token_source representa la capacidad para cancelar una operación que se puede cancelar.

Sintaxis

class cancellation_token_source;

Miembros

Constructores públicos

Nombre Descripción
cancellation_token_source Con sobrecarga. Construye un nuevo cancellation_token_source. El origen se puede usar para marcar la cancelación de alguna operación cancelable.
Destructor ~cancellation_token_source

Métodos públicos

Nombre Descripción
cancel Cancela el token. Cualquier objeto task_group, structured_task_group o task que utilice el token se cancelará con esta llamada y producirá una excepción en el siguiente punto de interrupción.
create_linked_source Con sobrecarga. Crea un objeto cancellation_token_source que se cancela al cancelar el token proporcionado.
get_token Devuelve un token de cancelación asociado a este origen. El token devuelto se puede sondear para la cancelación o puede proporcionar una devolución de llamada únicamente si se produce la cancelación.

Operadores públicos

Nombre Descripción
operator!=
operator=
operator==

Jerarquía de herencia

cancellation_token_source

Requisitos

Encabezado: pplcancellation_token.h

Espacio de nombres: simultaneidad

~cancellation_token_source

~cancellation_token_source();

cancel

Cancela el token. Cualquier objeto task_group, structured_task_group o task que utilice el token se cancelará con esta llamada y producirá una excepción en el siguiente punto de interrupción.

void cancel() const;

cancellation_token_source

Construye un nuevo cancellation_token_source. El origen se puede usar para marcar la cancelación de alguna operación cancelable.

cancellation_token_source();

cancellation_token_source(const cancellation_token_source& _Src);

cancellation_token_source(cancellation_token_source&& _Src);

Parámetros

_Src
Objeto que se va a copiar o mover.

create_linked_source

Crea un objeto cancellation_token_source que se cancela al cancelar el token proporcionado.

static cancellation_token_source create_linked_source(
    cancellation_token& _Src);

template<typename _Iter>
static cancellation_token_source create_linked_source(_Iter _Begin, _Iter _End);

Parámetros

_Iter
Tipo de iterador.

_Src
Token cuya cancelación provocará la cancelación del origen del token devuelto. Observe que el origen del token devuelto también se puede cancelar independientemente del origen incluido en este parámetro.

_Begin
Iterador de la biblioteca estándar de C++ que se corresponde con el principio del intervalo de tokens que se van a escuchar para determinar su cancelación.

_End
Iterador de la biblioteca estándar de C++ que se corresponde con el final del intervalo de tokens que se van a escuchar para determinar su cancelación.

Valor devuelto

cancellation_token_source que se cancela cuando se cancela el token proporcionado por el parámetro _Src.

get_token

Devuelve un token de cancelación asociado a este origen. El token devuelto se puede sondear para la cancelación o puede proporcionar una devolución de llamada únicamente si se produce la cancelación.

cancellation_token get_token() const;

Valor devuelto

Token de cancelación asociado a este origen.

operator!=

bool operator!= (const cancellation_token_source& _Src) const;

Parámetros

_Src
Operando.

Valor devuelto

operator=

cancellation_token_source& operator= (const cancellation_token_source& _Src);

cancellation_token_source& operator= (cancellation_token_source&& _Src);

Parámetros

_Src
Operando.

Valor devuelto

operator==

bool operator== (const cancellation_token_source& _Src) const;

Parámetros

_Src
Operando.

Valor devuelto

Consulte también

concurrency (espacio de nombres)