ChannelWriter<T>.WaitToWriteAsync(CancellationToken) Method

Definition

Namespace:

System.Threading.Channels

Assembly:

System.Threading.Channels.dll

Package:

System.Threading.Channels v9.0.0-preview.3.24172.9

Source:

ChannelWriter.cs

Returns a ValueTask<TResult> that will complete when space is available to write an item.

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)

Parameters

cancellationToken

CancellationToken

A CancellationToken used to cancel the wait operation.

Returns

ValueTask<Boolean>

A ValueTask<TResult> that will complete with a true result when space is available to write an item or with a false result when no further writing will be permitted.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.