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>

データの読み取りを実行できるようになると結果 true と共に完了し、チャネルが正常に完了したことでこれ以上データを読み取れない場合は結果 false と共に完了する ValueTask<TResult>。

チャネルが例外で完了した場合は、タスクも例外で完了します。

例外

OperationCanceledException

キャンセル トークンが取り消されました。 この例外は、返されたタスクに格納されます。