Classe cancellation_token_source

A classe cancellation_token_source representa a capacidade de cancelar alguma operação cancelável.

Sintaxe

class cancellation_token_source;

Membros

Construtores públicos

Nome	Descrição
cancellation_token_source	Sobrecarregado. Constrói um novo cancellation_token_source. É possível usar a origem para sinalizar o cancelamento de alguma operação cancelável.
Destruidor ~cancellation_token_source

Métodos públicos

Nome	Descrição
cancel	Cancela o token. Qualquer task_group, structured_task_group ou task que utiliza o token será cancelado nessa chamada e gerará uma exceção no próximo ponto de interrupção.
create_linked_source	Sobrecarregado. Cria um cancellation_token_source que será cancelado quando o token fornecido for cancelado.
get_token	Retorna um token de cancelamento associado a essa origem. É possível sondar o token retornado para cancelamento ou fornecer um retorno de chamada se e quando ocorrer o cancelamento.

Operadores públicos

Nome	Descrição
operator!=
operator=
operator==

Hierarquia de herança

cancellation_token_source

Requisitos

Cabeçalho: pplcancellation_token.h

Namespace: concurrency

~cancellation_token_source

~cancellation_token_source();

cancel

Cancela o token. Qualquer task_group, structured_task_group ou task que utiliza o token será cancelado nessa chamada e gerará uma exceção no próximo ponto de interrupção.

void cancel() const;

cancellation_token_source

Constrói um novo cancellation_token_source. É possível usar a origem para sinalizar o cancelamento de alguma operação cancelável.

cancellation_token_source();

cancellation_token_source(const cancellation_token_source& _Src);

cancellation_token_source(cancellation_token_source&& _Src);

Parâmetros

_Src
Objeto a ser copiado ou movido.

create_linked_source

Cria um cancellation_token_source que será cancelado quando o token fornecido for cancelado.

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
Um token cujo cancelamento causará o cancelamento da origem do token retornado. Observe que a origem do token retornado também poderá ser cancelada independentemente da origem contida nesse parâmetro.

_Begin
O iterador da Biblioteca Padrão C++ correspondente ao início do intervalo de tokens para escutar o cancelamento.

_End
O iterador da Biblioteca Padrão C++ correspondente ao final do intervalo de tokens para escutar o cancelamento.

Valor de Devolução

Um cancellation_token_source que é cancelado quando o token fornecido pelo parâmetro _Src é cancelado.

get_token

Retorna um token de cancelamento associado a essa origem. É possível sondar o token retornado para cancelamento ou fornecer um retorno de chamada se e quando ocorrer o cancelamento.

cancellation_token get_token() const;

Valor de Devolução

Um token de cancelamento associado a essa origem.

operator!=

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

Parâmetros

_Src
Operando.

Valor de Devolução

operator=

cancellation_token_source& operator= (const cancellation_token_source& _Src);

cancellation_token_source& operator= (cancellation_token_source&& _Src);

Parâmetros

_Src
Operando.

Valor de Devolução

operator==

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

Parâmetros

_Src
Operando.

Valor de Devolução

Confira também

Namespace de simultaneidade