JsonRpc.InvokeCoreAsync Methode

Definition

Namespace:

StreamJsonRpc

Assembly:

StreamJsonRpc.dll

Paket:

streamjsonrpc v2.21.10

Überlädt

Name	Beschreibung
InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, CancellationToken)	Ruft die angegebene RPC-Methode auf.
InvokeCoreAsync<TResult>(Nullable<Int64>, String, IReadOnlyList<Object>, CancellationToken)	Veraltet. Ruft die angegebene RPC-Methode auf.
InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, CancellationToken, Boolean)	Ruft die angegebene RPC-Methode auf.
InvokeCoreAsync<TResult>(Nullable<Int64>, String, IReadOnlyList<Object>, CancellationToken, Boolean)	Veraltet. Ruft eine bestimmte Methode auf einem JSON-RPC-Server auf.
InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, IReadOnlyList<Type>, IReadOnlyDictionary<String,Type>, CancellationToken, Boolean)	Ruft eine bestimmte Methode auf einem JSON-RPC-Server auf.

InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, CancellationToken)

Ruft die angegebene RPC-Methode auf.

protected System.Threading.Tasks.Task<TResult> InvokeCoreAsync<TResult>(StreamJsonRpc.RequestId id, string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments, System.Threading.CancellationToken cancellationToken);

member this.InvokeCoreAsync : StreamJsonRpc.RequestId * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>

Protected Function InvokeCoreAsync(Of TResult) (id As RequestId, targetName As String, arguments As IReadOnlyList(Of Object), cancellationToken As CancellationToken) As Task(Of TResult)

Typparameter

TResult

Rückgabetyp der RPC-Methode.

Parameter

id

RequestId

Ein vom Client festgelegter Bezeichner, der einen Zeichenfolgen-, Zahlen- oder NULL-Wert enthalten muss, falls enthalten. Wenn sie nicht enthalten ist, wird davon ausgegangen, dass es sich um eine Benachrichtigung handelt.

targetName

String

Name der aufzurufenden Methode. Darf nicht null oder leer sein.

arguments

IReadOnlyList<Object>

Argumente, die an die aufgerufene Methode übergeben werden sollen. Sie müssen mithilfe der ausgewählten IJsonRpcMessageFormatterserialisierbar sein. Wenn null, werden keine Argumente übergeben.

cancellationToken

CancellationToken

Das Token, dessen Abbruch dem Server signalisiert werden soll, die Verarbeitung dieser Anforderung zu beenden.

Gibt zurück

Task<TResult>

Eine Aufgabe, deren Ergebnis die deserialisierte Antwort vom JSON-RPC-Server ist.

InvokeCoreAsync<TResult>(Nullable<Int64>, String, IReadOnlyList<Object>, CancellationToken)

Achtung

Use the InvokeCoreAsync(RequestId, ...) overload instead.

Ruft die angegebene RPC-Methode auf.

[System.Obsolete("Use the InvokeCoreAsync(RequestId, ...) overload instead.")]
protected System.Threading.Tasks.Task<TResult> InvokeCoreAsync<TResult>(long? id, string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments, System.Threading.CancellationToken cancellationToken);

[<System.Obsolete("Use the InvokeCoreAsync(RequestId, ...) overload instead.")>]
member this.InvokeCoreAsync : Nullable<int64> * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>

Protected Function InvokeCoreAsync(Of TResult) (id As Nullable(Of Long), targetName As String, arguments As IReadOnlyList(Of Object), cancellationToken As CancellationToken) As Task(Of TResult)

Typparameter

TResult

Rückgabetyp der RPC-Methode.

Parameter

id

Nullable<Int64>

Ein vom Client festgelegter Bezeichner, der einen Zeichenfolgen-, Zahlen- oder NULL-Wert enthalten muss, falls enthalten. Wenn sie nicht enthalten ist, wird davon ausgegangen, dass es sich um eine Benachrichtigung handelt.

targetName

String

Name der aufzurufenden Methode. Darf nicht null oder leer sein.

arguments

IReadOnlyList<Object>

Argumente, die an die aufgerufene Methode übergeben werden sollen. Sie müssen mithilfe der ausgewählten IJsonRpcMessageFormatterserialisierbar sein. Wenn null, werden keine Argumente übergeben.

cancellationToken

CancellationToken

Das Token, dessen Abbruch dem Server signalisiert werden soll, die Verarbeitung dieser Anforderung zu beenden.

Gibt zurück

Task<TResult>

Eine Aufgabe, deren Ergebnis die deserialisierte Antwort vom JSON-RPC-Server ist.

Attribute

ObsoleteAttribute

InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, CancellationToken, Boolean)

Ruft die angegebene RPC-Methode auf.

protected System.Threading.Tasks.Task<TResult> InvokeCoreAsync<TResult>(StreamJsonRpc.RequestId id, string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments, System.Threading.CancellationToken cancellationToken, bool isParameterObject);

member this.InvokeCoreAsync : StreamJsonRpc.RequestId * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken * bool -> System.Threading.Tasks.Task<'Result>

Protected Function InvokeCoreAsync(Of TResult) (id As RequestId, targetName As String, arguments As IReadOnlyList(Of Object), cancellationToken As CancellationToken, isParameterObject As Boolean) As Task(Of TResult)

Typparameter

TResult

Rückgabetyp der RPC-Methode.

Parameter

id

RequestId

Ein vom Client eingerichteter Bezeichner. Wenn der Standardwert angegeben wird, wird davon ausgegangen, dass es sich um eine Benachrichtigung handelt.

targetName

String

Name der aufzurufenden Methode.

arguments

IReadOnlyList<Object>

Argumente, die an die aufgerufene Methode übergeben werden sollen. Wenn NULL, werden keine Argumente übergeben.

cancellationToken

CancellationToken

Das Token, dessen Abbruch dem Server signalisiert werden soll, die Verarbeitung dieser Anforderung zu beenden.

isParameterObject

Boolean

Wert, der angibt, ob der Parameter als Objekt übergeben werden soll.

Gibt zurück

Task<TResult>

Eine Aufgabe, deren Ergebnis die deserialisierte Antwort vom JSON-RPC-Server ist.

InvokeCoreAsync<TResult>(Nullable<Int64>, String, IReadOnlyList<Object>, CancellationToken, Boolean)

Achtung

Use the InvokeCoreAsync(RequestId, ...) overload instead.

Ruft eine bestimmte Methode auf einem JSON-RPC-Server auf.

[System.Obsolete("Use the InvokeCoreAsync(RequestId, ...) overload instead.")]
protected System.Threading.Tasks.Task<TResult> InvokeCoreAsync<TResult>(long? id, string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments, System.Threading.CancellationToken cancellationToken, bool isParameterObject);

[<System.Obsolete("Use the InvokeCoreAsync(RequestId, ...) overload instead.")>]
member this.InvokeCoreAsync : Nullable<int64> * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken * bool -> System.Threading.Tasks.Task<'Result>

Protected Function InvokeCoreAsync(Of TResult) (id As Nullable(Of Long), targetName As String, arguments As IReadOnlyList(Of Object), cancellationToken As CancellationToken, isParameterObject As Boolean) As Task(Of TResult)

Typparameter

TResult

Rückgabetyp der RPC-Methode.

Parameter

id

Nullable<Int64>

Ein vom Client eingerichteter Bezeichner. Wenn der Standardwert angegeben wird, wird davon ausgegangen, dass es sich um eine Benachrichtigung handelt.

targetName

String

Name der aufzurufenden Methode. Darf nicht null oder leer sein.

arguments

IReadOnlyList<Object>

Argumente, die an die aufgerufene Methode übergeben werden sollen. Sie müssen mithilfe der ausgewählten IJsonRpcMessageFormatterserialisierbar sein. Wenn null, werden keine Argumente übergeben.

cancellationToken

CancellationToken

Das Token, dessen Abbruch dem Server signalisiert werden soll, die Verarbeitung dieser Anforderung zu beenden.

isParameterObject

Boolean

Wert, der angibt, ob der Parameter als Objekt übergeben werden soll.

Gibt zurück

Task<TResult>

Eine Aufgabe, deren Ergebnis die deserialisierte Antwort vom JSON-RPC-Server ist.

Attribute

ObsoleteAttribute

InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, IReadOnlyList<Type>, IReadOnlyDictionary<String,Type>, CancellationToken, Boolean)

Ruft eine bestimmte Methode auf einem JSON-RPC-Server auf.

protected System.Threading.Tasks.Task<TResult> InvokeCoreAsync<TResult>(StreamJsonRpc.RequestId id, string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments, System.Collections.Generic.IReadOnlyList<Type>? positionalArgumentDeclaredTypes, System.Collections.Generic.IReadOnlyDictionary<string,Type>? namedArgumentDeclaredTypes, System.Threading.CancellationToken cancellationToken, bool isParameterObject);

member this.InvokeCoreAsync : StreamJsonRpc.RequestId * string * System.Collections.Generic.IReadOnlyList<obj> * System.Collections.Generic.IReadOnlyList<Type> * System.Collections.Generic.IReadOnlyDictionary<string, Type> * System.Threading.CancellationToken * bool -> System.Threading.Tasks.Task<'Result>

Protected Function InvokeCoreAsync(Of TResult) (id As RequestId, targetName As String, arguments As IReadOnlyList(Of Object), positionalArgumentDeclaredTypes As IReadOnlyList(Of Type), namedArgumentDeclaredTypes As IReadOnlyDictionary(Of String, Type), cancellationToken As CancellationToken, isParameterObject As Boolean) As Task(Of TResult)

Typparameter

TResult

Rückgabetyp der RPC-Methode.

Parameter

id

RequestId

Ein vom Client eingerichteter Bezeichner. Wenn der Standardwert angegeben wird, wird davon ausgegangen, dass es sich um eine Benachrichtigung handelt.

targetName

String

Name der aufzurufenden Methode. Darf nicht null oder leer sein.

arguments

IReadOnlyList<Object>

Argumente, die an die aufgerufene Methode übergeben werden sollen. Sie müssen mithilfe der ausgewählten IJsonRpcMessageFormatterserialisierbar sein. Wenn null, werden keine Argumente übergeben.

positionalArgumentDeclaredTypes

IReadOnlyList<Type>

Eine Liste der Type Objekte, die beschreiben, wie jedes Element in arguments vom Server typiert werden soll. Wenn angegeben, muss dies genau dieselbe Länge wie arguments haben und keine null Elemente enthalten. Dieser Wert wird ignoriert, wenn isParameterObject wahr ist.

namedArgumentDeclaredTypes

IReadOnlyDictionary<String,Type>

Ein Wörterbuch mit Type Objekten, die beschreiben, wie jeder Eintrag in der IReadOnlyDictionary<TKey,TValue> im einzigen Element von arguments vom Server eingegeben werden soll. Wenn angegeben, muss dies genau den gleichen Satz von Schlüsseln wie das Wörterbuch aufweisen, das im ersten Element von argumentsenthalten ist, und keine null Werte enthalten.

cancellationToken

CancellationToken

Das Token, dessen Abbruch dem Server signalisiert werden soll, die Verarbeitung dieser Anforderung zu beenden.

isParameterObject

Boolean

Wert, der angibt, ob der Parameter als Objekt übergeben werden soll.

Gibt zurück

Task<TResult>

Eine Aufgabe, die mit der Antwort vom JSON-RPC-Server abgeschlossen wird.

Ausnahmen

OperationCanceledException

Wird ausgelöst, nachdem cancellationToken abgebrochen wurde. Wenn die Anforderung bereits übertragen wurde, wird die Ausnahme erst ausgelöst, nachdem der Server die Abbruchbenachrichtigung empfangen und darauf geantwortet hat. Wenn der Server die Anforderung abschließt, anstatt sie abzusagen, wird diese Ausnahme nicht ausgelöst. Wenn die Verbindung vor dem Empfang einer Antwort abbricht, wird diese Ausnahme ausgelöst, wenn cancellationToken abgebrochen wurde.

RemoteRpcException

Eine allgemeine Basisklasse für eine Vielzahl von RPC-Ausnahmen, die ausgelöst werden können. Einige gängige abgeleitete Typen werden einzeln aufgelistet.

RemoteInvocationException

Wird ausgelöst, wenn ein Fehler vom Server zurückgegeben wird, was auf die Ausführung der angeforderten Methode zurückzuführen ist.

RemoteMethodNotFoundException

Wird ausgelöst, wenn der Server meldet, dass keine übereinstimmende Methode aufgerufen wurde.

ArgumentNullException

Wenn targetName null ist.

ArgumentException

Wird ausgelöst, wenn targetName leer ist.

ObjectDisposedException

Wenn diese Instanz von JsonRpc bereits vor diesem Aufruf verworfen wurde.

ConnectionLostException

Wird ausgelöst, wenn die Verbindung vor der Anforderung beendet wird oder während die Anforderung ausgeführt wird, es sei denn, cancellationToken wird bereits signalisiert.

Exception

Jede Ausnahme, die vom IJsonRpcMessageFormatter ausgelöst wird (in der Regel aufgrund von Serialisierungsfehlern). Wenn Sie JsonMessageFormatter verwenden, sollte dies Newtonsoft.Json.JsonSerializationExceptionsein. Wenn Sie MessagePackFormatter verwenden, sollte dies MessagePack.MessagePackSerializationExceptionsein.