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

Métodos públicos

Operadores públicos

Hierarquia de herança

cancellation_token_source

Requisitos

Cabeçalho: pplcancellation_token.h

Namespace: simultaneidade

~ cancellation_token_source

~cancellation_token_source();

cancelar

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;

fonte_do_token_de_cancelamento

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.

criar_fonte_vinculada

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 acompanhar o cancelamento.

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

Valor de retorno

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 verificar o token retornado para cancelamento ou fornecer um callback caso o cancelamento ocorra.

cancellation_token get_token() const;

Valor de retorno

Um token de cancelamento associado a esta fonte.

operator!=

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

Parâmetros

_Src
Operando.

Valor de retorno

operator=

cancellation_token_source& operator= (const cancellation_token_source& _Src);

cancellation_token_source& operator= (cancellation_token_source&& _Src);

Parâmetros

_Src
Operando.

Valor de retorno

operator==

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

Parâmetros

_Src
Operando.

Valor de retorno

Confira também

Namespace de concorrência