ChannelReader<T>.ReadAllAsync(CancellationToken) Metoda

Definice

Obor názvů:

System.Threading.Channels

Sestavení:

System.Threading.Channels.dll

Zdroj:

ChannelReader.cs

Vytvoří objekt IAsyncEnumerable<T> , který umožňuje čtení všech dat z kanálu.

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 zrušení, který se použije ke zrušení výčtu. Pokud jsou data okamžitě připravená ke čtení, pak se můžou získat i po požadavku na zrušení.

Návraty

IAsyncEnumerable<T>

Vytvoření asynchronního výčtu.

Výjimky

OperationCanceledException

Token zrušení byl zrušen. Tato výjimka se uloží do vrácené úlohy.

Poznámky

Každé MoveNextAsync() volání, které se vrátí true , přečte z kanálu další položku.

MoveNextAsync() vrátí hodnotu, false jakmile nebudou nebo nebudou k dispozici další data ke čtení.