IJsonRpcMessageHandler.ReadAsync(CancellationToken) Metoda

Definicja

Odczytuje odrębny i kompletny komunikat z transportu, czekając na jeden w razie potrzeby.

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>
Public Function ReadAsync (cancellationToken As CancellationToken) As ValueTask(Of JsonRpcMessage)

Parametry

cancellationToken
CancellationToken

Token umożliwiający anulowanie żądania odczytu.

Zwraca

Odebrany komunikat lub null jeśli podstawowy transport kończy się przed rozpoczęciem innego komunikatu.

Wyjątki

Zgłaszany, gdy CanRead zwraca falsewartość .

Zgłaszany, jeśli transport kończy się podczas odczytywania komunikatu.

Zgłaszany, jeśli cancellationToken zostanie anulowany przed odebraniem nowej wiadomości.

Uwagi

Implementacje mogą zakładać, że ta metoda nigdy nie jest wywoływana przed ukończeniem żadnego wyniku asynchronicznego z poprzedniego wywołania tej metody.

Dotyczy