ChannelWriter<T>.WaitToWriteAsync(CancellationToken) メソッド

定義

名前空間:

System.Threading.Channels

アセンブリ:

System.Threading.Channels.dll

ソース:

ChannelWriter.cs

項目を書き込むための空き領域が利用可能になると完了する ValueTask<TResult> を返します。

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

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

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

パラメーター

cancellationToken

CancellationToken

待機操作をキャンセルするために使用する CancellationToken。

戻り値

ValueTask<Boolean>

項目を書き込むための空き領域を利用できる場合は結果 true と共に完了し、それ以上の書き込みが許可されない場合は結果 false と共に完了する ValueTask<TResult>。

例外

OperationCanceledException

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