PipeWriter.FlushAsync(CancellationToken) Method

Definition

Namespace:

System.IO.Pipelines

Assembly:

System.IO.Pipelines.dll

Package:

System.IO.Pipelines v8.0.0

Source:

PipeWriter.cs

Makes bytes written available to PipeReader and runs ReadAsync(CancellationToken) continuation.

public abstract System.Threading.Tasks.ValueTask<System.IO.Pipelines.FlushResult> FlushAsync (System.Threading.CancellationToken cancellationToken = default);

abstract member FlushAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.IO.Pipelines.FlushResult>

Public MustOverride Function FlushAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of FlushResult)

Parameters

cancellationToken

CancellationToken

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

Returns

ValueTask<FlushResult>

A task that represents and wraps the asynchronous flush operation.

Exceptions

OperationCanceledException

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