ChannelReader<T>.WaitToReadAsync(CancellationToken) 方法

定義

命名空間:

System.Threading.Channels

組件:

System.Threading.Channels.dll

來源:

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

取消權杖已取消。 此例外狀況會儲存在傳回的工作中。