ChannelWriter<T>.WriteAsync(T, CancellationToken) Method

Definition

Asynchronously writes an item to the channel.

public virtual System.Threading.Tasks.ValueTask WriteAsync (T item, System.Threading.CancellationToken cancellationToken = default);

Parameters

item
T

The value to write to the channel.

cancellationToken
CancellationToken

A CancellationToken used to cancel the write operation.

Returns

A ValueTask that represents the asynchronous write operation.

Exceptions

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

Applies to

Product Versions
.NET Core 3.0, Core 3.1, 5, 6, 7, 8 (package-provided), 8, 9 (package-provided), 9
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided), 2.1 (package-provided)