ChannelReader<T>.ReadAllAsync(CancellationToken) Metoda

Definicja

Przestrzeń nazw:

System.Threading.Channels

Zestaw:

System.Threading.Channels.dll

Pakiet:

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

Źródło:

ChannelReader.cs

Tworzy obiekt IAsyncEnumerable<T> , który umożliwia odczytywanie wszystkich danych z kanału.

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)

Parametry

cancellationToken

CancellationToken

Token anulowania używany do anulowania wyliczenia. Jeśli dane są natychmiast gotowe do odczytu, dane te mogą być zwracane nawet po żądaniu anulowania.

Zwraca

IAsyncEnumerable<T>

Utworzony asynchroniczny element wyliczalny.

Wyjątki

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Każde MoveNextAsync() zwracane true wywołanie odczytuje następny element z kanału.

MoveNextAsync() funkcja zwraca false wartość , gdy nie ma więcej danych lub kiedykolwiek będzie dostępna do odczytu.