ChannelWriter<T>.WriteAsync(T, 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

Asynchronously writes an item to the channel.

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

abstract member WriteAsync : 'T * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
override this.WriteAsync : 'T * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask

Public Overridable Function WriteAsync (item As T, Optional cancellationToken As CancellationToken = Nothing) As ValueTask

Parameters

item

T

The value to write to the channel.

cancellationToken

CancellationToken

A CancellationToken used to cancel the write operation.

Returns

ValueTask

A ValueTask that represents the asynchronous write operation.

Exceptions

OperationCanceledException

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