ChannelReader<T>.WaitToReadAsync(CancellationToken) 方法

定义

命名空间:

System.Threading.Channels

程序集:

System.Threading.Channels.dll

Source:

ChannelReader.cs

返回将在有数据可供读取时完成的 ValueTask<TResult>。

public abstract System.Threading.Tasks.ValueTask<bool> WaitToReadAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member WaitToReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<bool>

Public MustOverride Function WaitToReadAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Boolean)

参数

cancellationToken

CancellationToken

用于取消等待操作的 CancellationToken。

返回

ValueTask<Boolean>

ValueTask<TResult>，它将在有数据可供读取时完成，并返回 true 结果；或将在因通道成功完成而不再有数据可供读取时完成，并返回 false 结果。

如果通道完成但出现异常，则任务也将在异常情况下完成。

例外

OperationCanceledException

取消令牌已取消。 此异常存储在返回的任务中。