ChannelReader<T>.ReadAllAsync(CancellationToken) Метод

Определение

Пространство имен:

System.Threading.Channels

Сборка:

System.Threading.Channels.dll

Исходный код:

ChannelReader.cs

Создает интерфейс IAsyncEnumerable<T>, позволяющий считывать все данные из канала.

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)

Параметры

cancellationToken

CancellationToken

Токен отмены для отмены перечисления. Если данные сразу готовы к чтению, эти данные могут быть возвращены даже после запроса отмены.

Возвращаемое значение

IAsyncEnumerable<T>

Созданное асинхронное перечисление.

Исключения

OperationCanceledException

Маркер отмены был отменен. Это исключение сохраняется в возвращаемой задаче.

Комментарии

Каждый MoveNextAsync() возвращаемый true вызов будет считывать следующий элемент из канала.

MoveNextAsync() возвращается false , как только данные больше не будут доступны или когда-либо будут доступны для чтения.