ChannelWriter<T>.WriteAsync(T, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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
A ValueTask that represents the asynchronous write operation.
Exceptions
The cancellation token was canceled. This exception is stored into the returned task.
Applies to
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.