PipeWriter.WriteAsync(ReadOnlyMemory<Byte>, CancellationToken) Method

Reference

Definition

Namespace:: System.IO.Pipelines

Assembly:: System.IO.Pipelines.dll

Package:: System.IO.Pipelines v9.0.0

Source:: PipeWriter.cs

Source:: PipeWriter.cs

Source:: PipeWriter.cs

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.

Writes the specified byte memory range to the pipe and makes data accessible to the PipeReader.

public virtual System.Threading.Tasks.ValueTask<System.IO.Pipelines.FlushResult> WriteAsync (ReadOnlyMemory<byte> source, System.Threading.CancellationToken cancellationToken = default);

abstract member WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.IO.Pipelines.FlushResult>
override this.WriteAsync : ReadOnlyMemory<byte> * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.IO.Pipelines.FlushResult>

Public Overridable Function WriteAsync (source As ReadOnlyMemory(Of Byte), Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of FlushResult)

Parameters

source: ReadOnlyMemory<Byte>

The read-only byte memory region to write.

cancellationToken: CancellationToken

The token to monitor for cancellation requests. The default value is None.

Returns

ValueTask<FlushResult>

A task that represents the asynchronous write operation, and wraps the flush asynchronous operation.

Exceptions

OperationCanceledException

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

Applies to

Jaa