JsonRpc.InvokeCoreAsync メソッド

定義

名前空間:

StreamJsonRpc

アセンブリ:

StreamJsonRpc.dll

パッケージ:

streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmanada9c\StreamJsonRpc.2.9.85

オーバーロード

InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, CancellationToken)	指定した RPC メソッドを呼び出します。
InvokeCoreAsync<TResult>(Nullable<Int64>, String, IReadOnlyList<Object>, CancellationToken)	古い. 指定した RPC メソッドを呼び出します。
InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, CancellationToken, Boolean)	指定した RPC メソッドを呼び出します。
InvokeCoreAsync<TResult>(Nullable<Int64>, String, IReadOnlyList<Object>, CancellationToken, Boolean)	古い. JSON-RPC サーバーで特定のメソッドを呼び出します。
InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, IReadOnlyList<Type>, IReadOnlyDictionary<String,Type>, CancellationToken, Boolean)	JSON-RPC サーバーで特定のメソッドを呼び出します。

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

指定した RPC メソッドを呼び出します。

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)

型パラメーター

TResult

RPC メソッドの戻り値の型。

パラメーター

id

RequestId

含まれている場合は、文字列、数値、または NULL 値を含む必要があるクライアントによって確立された識別子。 含まれていない場合は、通知であると見なされます。

targetName

String

呼び出すメソッドの名前。 null または空にすることはできません。

arguments

IReadOnlyList<Object>

呼び出されたメソッドに渡す引数。 これらは、選択した IJsonRpcMessageFormatter値を使用してシリアル化できる必要があります。 の場合 null、引数は渡されません。

cancellationToken

CancellationToken

この要求の処理を停止するようにサーバーに通知する必要があるキャンセルのトークン。

戻り値

Task<TResult>

結果が JSON-RPC サーバーからの逆シリアル化された応答であるタスク。

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

注意事項

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

指定した RPC メソッドを呼び出します。

[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)

型パラメーター

TResult

RPC メソッドの戻り値の型。

パラメーター

id

Nullable<Int64>

含まれている場合は、文字列、数値、または NULL 値を含む必要があるクライアントによって確立された識別子。 含まれていない場合は、通知であると見なされます。

targetName

String

呼び出すメソッドの名前。 null または空にすることはできません。

arguments

IReadOnlyList<Object>

呼び出されたメソッドに渡す引数。 これらは、選択した IJsonRpcMessageFormatter値を使用してシリアル化できる必要があります。 の場合 null、引数は渡されません。

cancellationToken

CancellationToken

この要求の処理を停止するようにサーバーに通知する必要があるキャンセルのトークン。

戻り値

Task<TResult>

結果が JSON-RPC サーバーからの逆シリアル化された応答であるタスク。

属性

ObsoleteAttribute

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

指定した RPC メソッドを呼び出します。

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)

型パラメーター

TResult

RPC メソッドの戻り値の型。

パラメーター

id

RequestId

クライアントによって確立された識別子。 既定値が指定されている場合は、通知と見なされます。

targetName

String

呼び出すメソッドの名前。

arguments

IReadOnlyList<Object>

呼び出されたメソッドに渡す引数。 null の場合、引数は渡されません。

cancellationToken

CancellationToken

この要求の処理を停止するようにサーバーに通知する必要があるキャンセルのトークン。

isParameterObject

Boolean

パラメーターをオブジェクトとして渡す必要があるかどうかを示す値。

戻り値

Task<TResult>

結果が JSON-RPC サーバーからの逆シリアル化された応答であるタスク。

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

注意事項

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

JSON-RPC サーバーで特定のメソッドを呼び出します。

[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)

型パラメーター

TResult

RPC メソッドの戻り値の型。

パラメーター

id

Nullable<Int64>

クライアントによって確立された識別子。 既定値が指定されている場合は、通知と見なされます。

targetName

String

呼び出すメソッドの名前。 null または空にすることはできません。

arguments

IReadOnlyList<Object>

呼び出されたメソッドに渡す引数。 これらは、選択した IJsonRpcMessageFormatter値を使用してシリアル化できる必要があります。 の場合 null、引数は渡されません。

cancellationToken

CancellationToken

この要求の処理を停止するようにサーバーに通知する必要があるキャンセルのトークン。

isParameterObject

Boolean

パラメーターをオブジェクトとして渡す必要があるかどうかを示す値。

戻り値

Task<TResult>

結果が JSON-RPC サーバーからの逆シリアル化された応答であるタスク。

属性

ObsoleteAttribute

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

JSON-RPC サーバーで特定のメソッドを呼び出します。

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)

型パラメーター

TResult

RPC メソッドの戻り値の型。

パラメーター

id

RequestId

クライアントによって確立された識別子。 既定値が指定されている場合は、通知と見なされます。

targetName

String

呼び出すメソッドの名前。 null または空にすることはできません。

arguments

IReadOnlyList<Object>

呼び出されたメソッドに渡す引数。 これらは、選択した IJsonRpcMessageFormatter値を使用してシリアル化できる必要があります。 の場合 null、引数は渡されません。

positionalArgumentDeclaredTypes

IReadOnlyList<Type>

各要素がどのように Type サーバーに arguments 入力されるかを記述するオブジェクトの一覧。 指定する場合、これは要素とまったく同じ長さ arguments であり、要素を含まなければなりません null 。 true の場合 isParameterObject 、この値は無視されます。

namedArgumentDeclaredTypes

IReadOnlyDictionary<String,Type>

唯一の Type 要素で IReadOnlyDictionary<TKey,TValue> 指定された各エントリが、サーバーによって型指定される方法を記述するオブジェクトの arguments ディクショナリ。 指定する場合、これは、最初の要素 argumentsに含まれるディクショナリとまったく同じキーセットを持ち、値を含まなければなりません null 。

cancellationToken

CancellationToken

この要求の処理を停止するようにサーバーに通知する必要があるキャンセルのトークン。

isParameterObject

Boolean

パラメーターをオブジェクトとして渡す必要があるかどうかを示す値。

戻り値

Task<TResult>

JSON-RPC サーバーからの応答で完了するタスク。

例外

OperationCanceledException

取り消された後 cancellationToken にスローされます。 要求が既に送信されている場合、例外は、サーバーがキャンセル通知を受信して応答した後にのみスローされます。 サーバーが取り消す代わりに要求を完了した場合、この例外はスローされません。 応答を受信する前に接続が切断されると、この例外は取り消された場合 cancellationToken にスローされます。

RemoteRpcException

スローされる可能性があるさまざまな RPC 例外の共通基底クラス。 一般的な派生型の一部が個別に一覧表示されます。

RemoteInvocationException

要求されたメソッドを実行した結果、サーバーからエラーが返されたときにスローされます。

RemoteMethodNotFoundException

呼び出す一致するメソッドが見つからなかったことをサーバーが報告したときにスローされます。

ArgumentNullException

null の場合 targetName 。

ArgumentException

空の場合に targetName スローされます。

ObjectDisposedException

このインスタンスがこの呼び出しの JsonRpc 前に既に破棄されている場合。

ConnectionLostException

既に通知されていない限り cancellationToken 、要求の前または要求の進行中に接続が (どちらかの側で) 終了したときにスローされます。

Exception

によって IJsonRpcMessageFormatter スローされる例外 (通常はシリアル化エラーが原因)。 これを使用JsonMessageFormatterする場合は.Newtonsoft.Json.JsonSerializationException これを使用MessagePackFormatterする場合は.MessagePack.MessagePackSerializationException