cancellation_token Classe

A cancellation_token classe representa a capacidade de determinar se alguma operação foi solicitada para cancelar. Um dado token pode ser associado a um task_group, structured_task_group ou task para fornecer cancelamento implícito. Também pode ser consultado para cancelamento ou ter um callback registado se e quando o associado cancellation_token_source for cancelado.

Sintaxe

class cancellation_token;

Membros

Construtores Públicos

Métodos Públicos

Operadores Públicos

Hierarquia de herança

cancellation_token

Requerimentos

Cabeçalho: pplcancellation_token.h

Namespace: simultaneidade

~cancellation_token

~cancellation_token();

token_de_cancelamento

cancellation_token(const cancellation_token& _Src);

cancellation_token(cancellation_token&& _Src);

Parâmetros

_Src
O token de cancelamento a ser copiado ou movido.

deregister_callback

Remove-se um callback previamente registado pelo método register, com base no objeto cancellation_token_registration devolvido no momento do registo.

void deregister_callback(const cancellation_token_registration& _Registration) const;

Parâmetros

_Registration
O cancellation_token_registration objeto correspondente ao callback a ser desregistado. Este token deve ter sido devolvido anteriormente a partir de uma chamada ao register método.

is_cancelable

Devolve uma indicação de se este token pode ser cancelado ou não.

bool is_cancelable() const;

Valor de retorno

Uma indicação de se este token pode ser cancelado ou não.

é_cancelado

Devolve true se o token tiver sido cancelado.

bool is_canceled() const;

Valor de retorno

O valor true se o token tiver sido cancelado; caso contrário, o valor false.

nenhuma

Devolve um token de cancelamento que nunca pode ser sujeito a cancelamento.

static cancellation_token none();

Valor de retorno

Um token de cancelamento que não pode ser cancelado.

operador!=

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

Parâmetros

_Src
O cancellation_token para comparar.

Valor de retorno

operador=

cancellation_token& operator= (const cancellation_token& _Src);

cancellation_token& operator= (cancellation_token&& _Src);

Parâmetros

_Src
A cancellation_token atribuir.

Valor de retorno

operador==

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

Parâmetros

_Src
O cancellation_token para comparar.

Valor de retorno

register_callback

Regista uma função de callback com o token. Se e quando o token for cancelado, será efetuada a chamada de retorno. Note que, se o token já estiver cancelado no ponto onde este método é chamado, o callback será feito imediatamente e de forma síncrona.

template<typename _Function>
::Concurrency::cancellation_token_registration register_callback(const _Function& _Func) const;

Parâmetros

_Function
O tipo do objeto de função que será invocado quando este cancellation_token for cancelado.

_Func
O objeto de função que será invocado quando este cancellation_token for cancelado.

Valor de retorno

Um cancellation_token_registration objeto que pode ser utilizado no deregister método para desregistar um callback previamente registado e evitar que seja executado. O método lançará uma exceção "invalid_operation" se for chamado num objeto criado usando o "cancellation_token::none".

Consulte também

concorrência Namespace