PipeMessageHandler.ReadAtLeastAsync(Int32, Boolean, CancellationToken) Method

  • Reference

Definition

Namespace:
StreamJsonRpc
Assembly:
StreamJsonRpc.dll
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman5d493\StreamJsonRpc.2.0.208
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmana13ca\StreamJsonRpc.2.1.74
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman29ef6\StreamJsonRpc.2.2.53
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmanc61ca\StreamJsonRpc.2.3.112
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman810ce\StreamJsonRpc.2.4.48
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmanb9d67\StreamJsonRpc.2.5.46
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman90a9c\StreamJsonRpc.2.6.121
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman01f82\StreamJsonRpc.2.7.76
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmaned549\StreamJsonRpc.2.8.28
Package:
streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmanada9c\StreamJsonRpc.2.9.85

Reads from the Reader until at least a specified number of bytes are available.

protected System.Threading.Tasks.ValueTask<System.IO.Pipelines.ReadResult> ReadAtLeastAsync (int requiredBytes, bool allowEmpty, System.Threading.CancellationToken cancellationToken);
member this.ReadAtLeastAsync : int * bool * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<System.IO.Pipelines.ReadResult>
Protected Function ReadAtLeastAsync (requiredBytes As Integer, allowEmpty As Boolean, cancellationToken As CancellationToken) As ValueTask(Of ReadResult)

Parameters

requiredBytes
Int32

The number of bytes that must be available.

allowEmpty
Boolean

true to allow returning 0 bytes if the end of the stream is encountered before any bytes are read.

cancellationToken
CancellationToken

A cancellation token.

Returns

ValueTask<ReadResult>

The ReadResult containing at least requiredBytes bytes.

Exceptions

OperationCanceledException

Thrown if IsCanceled.

EndOfStreamException

Thrown if IsCompleted before we have requiredBytes bytes. Not thrown if 0 bytes were read and allowEmpty is true.

Applies to