Share via

MessageHandlerBase.ReadAsync(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 a distinct and complete message from the transport, waiting for one if necessary.

public System.Threading.Tasks.ValueTask<StreamJsonRpc.Protocol.JsonRpcMessage> ReadAsync (System.Threading.CancellationToken cancellationToken);
public System.Threading.Tasks.ValueTask<StreamJsonRpc.Protocol.JsonRpcMessage?> ReadAsync (System.Threading.CancellationToken cancellationToken);
abstract member ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<StreamJsonRpc.Protocol.JsonRpcMessage>
override this.ReadAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<StreamJsonRpc.Protocol.JsonRpcMessage>
Public Function ReadAsync (cancellationToken As CancellationToken) As ValueTask(Of JsonRpcMessage)

Parameters

cancellationToken
CancellationToken

A token to cancel the read request.

Returns

ValueTask<JsonRpcMessage>

The received message, or null if the underlying transport ends before beginning another message.

Implements

ReadAsync(CancellationToken)

Exceptions

InvalidOperationException

Thrown when CanRead returns false.

EndOfStreamException

Thrown if the transport ends while reading a message.

OperationCanceledException

Thrown if cancellationToken is canceled before a new message is received.

Remarks

Implementations may assume this method is never called before any async result from a prior call to this method has completed.

Applies to