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

Definición

Espacio de nombres:

System.Threading.Channels

Ensamblado:

System.Threading.Channels.dll

Paquete:

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

Source:

ChannelReader.cs

Crea una instancia de IAsyncEnumerable<T> que permite leer todos los datos del 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

Token de cancelación que se va a usar para cancelar la enumeración. Si los datos están listos para leerse inmediatamente, esos datos se pueden producir incluso después de que se haya solicitado la cancelación.

Devoluciones

IAsyncEnumerable<T>

El enumerable asincrónico que se ha creado.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

Cada MoveNextAsync() llamada que devuelve true leerá el siguiente elemento fuera del canal.

MoveNextAsync() devuelve false una vez que no haya más datos o estará disponible para leerse.