ChannelReader<T>.ReadAllAsync(CancellationToken) Método

Definição

Namespace:

System.Threading.Channels

Assembly:

System.Threading.Channels.dll

Pacote:

System.Threading.Channels v9.0.0-preview.4.24266.19

Origem:

ChannelReader.cs

Cria um IAsyncEnumerable<T> que habilita a leitura de todos os dados do canal.

public virtual System.Collections.Generic.IAsyncEnumerable<T> ReadAllAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member ReadAllAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'T>
override this.ReadAllAsync : System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<'T>

Public Overridable Function ReadAllAsync (Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of T)

Parâmetros

cancellationToken

CancellationToken

O token de cancelamento a ser usado para cancelar a enumeração. Se os dados estiverem imediatamente prontos para leitura, esses dados poderão ser gerados mesmo após a solicitação de cancelamento.

Retornos

IAsyncEnumerable<T>

O enumerável assíncrono criado.

Exceções

OperationCanceledException

O token de cancelamento foi cancelado. Essa exceção é armazenada na tarefa retornada.

Comentários

Cada MoveNextAsync() chamada retornada true lerá o próximo item fora do canal.

MoveNextAsync() retorna false quando não há mais dados ou estarão disponíveis para leitura.