JsonRpc.InvokeCoreAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
InvokeCoreAsync<TResult>(RequestId, String, IReadOnlyList<Object>, CancellationToken) |
Вызывает указанный метод RPC. |
InvokeCoreAsync<TResult>(Nullable<Int32>, 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<Int32>, 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
Идентификатор, установленный клиентом, который должен содержать значение String, Number или NULL, если оно включено. Если он не включен, предполагается, что он является уведомлением.
- targetName
- String
Имя вызываемого метода. Не должен иметь значение NULL или быть пустым.
- arguments
- IReadOnlyList<Object>
Аргументы для передачи в вызываемый метод. Они должны быть сериализуемыми с помощью выбранного.IJsonRpcMessageFormatter Если null
аргументы не передаются.
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
Возвращаемое значение
Задача, результатом которой является десериализованный ответ с сервера JSON-RPC.
Применяется к
InvokeCoreAsync<TResult>(Nullable<Int32>, String, IReadOnlyList<Object>, CancellationToken)
Вызывает указанный метод RPC
protected virtual System.Threading.Tasks.Task<TResult> InvokeCoreAsync<TResult> (int? id, string targetName, System.Collections.Generic.IReadOnlyList<object> arguments, System.Threading.CancellationToken cancellationToken);
abstract member InvokeCoreAsync : Nullable<int> * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>
override this.InvokeCoreAsync : Nullable<int> * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>
Protected Overridable Function InvokeCoreAsync(Of TResult) (id As Nullable(Of Integer), targetName As String, arguments As IReadOnlyList(Of Object), cancellationToken As CancellationToken) As Task(Of TResult)
Параметры типа
- TResult
Тип возвращаемого значения метода RPC
Параметры
Идентификатор, установленный клиентом, который должен содержать значение String, Number или NULL, если оно включено. Если он не включен, предполагается, что он является уведомлением.
- targetName
- String
Имя вызываемого метода.
- arguments
- IReadOnlyList<Object>
Аргументы для передачи в вызываемый метод. Если задано значение NULL, аргументы не передаются.
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
Возвращаемое значение
Задача, результатом которой является десериализованный ответ с сервера JSON-RPC.
Применяется к
InvokeCoreAsync<TResult>(Nullable<Int64>, String, IReadOnlyList<Object>, CancellationToken)
Внимание!
Use the InvokeCoreAsync(RequestId, ...) overload instead.
Вызывает указанный метод RPC.
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.")]
protected System.Threading.Tasks.Task<TResult> InvokeCoreAsync<TResult> (long? id, string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments, System.Threading.CancellationToken cancellationToken);
member this.InvokeCoreAsync : Nullable<int64> * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'Result>
[<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.
Параметры
Идентификатор, установленный клиентом, который должен содержать значение String, Number или NULL, если оно включено. Если он не включен, предполагается, что он является уведомлением.
- targetName
- String
Имя вызываемого метода. Не должен иметь значение NULL или быть пустым.
- arguments
- IReadOnlyList<Object>
Аргументы для передачи в вызываемый метод. Они должны быть сериализуемыми с помощью выбранного.IJsonRpcMessageFormatter Если null
аргументы не передаются.
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
Возвращаемое значение
Задача, результатом которой является десериализованный ответ с сервера JSON-RPC.
- Атрибуты
Применяется к
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
Значение, указывающее, следует ли передавать параметр в качестве объекта.
Возвращаемое значение
Задача, результатом которой является десериализованный ответ с сервера JSON-RPC.
Применяется к
InvokeCoreAsync<TResult>(Nullable<Int32>, String, IReadOnlyList<Object>, CancellationToken, Boolean)
Вызывает указанный метод RPC
protected virtual System.Threading.Tasks.Task<TResult> InvokeCoreAsync<TResult> (int? id, string targetName, System.Collections.Generic.IReadOnlyList<object> arguments, System.Threading.CancellationToken cancellationToken, bool isParameterObject);
abstract member InvokeCoreAsync : Nullable<int> * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken * bool -> System.Threading.Tasks.Task<'Result>
override this.InvokeCoreAsync : Nullable<int> * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken * bool -> System.Threading.Tasks.Task<'Result>
Protected Overridable Function InvokeCoreAsync(Of TResult) (id As Nullable(Of Integer), targetName As String, arguments As IReadOnlyList(Of Object), cancellationToken As CancellationToken, isParameterObject As Boolean) As Task(Of TResult)
Параметры типа
- TResult
Тип возвращаемого значения метода RPC
Параметры
Идентификатор, установленный клиентом, который должен содержать значение String, Number или NULL, если оно включено. Если он не включен, предполагается, что он является уведомлением.
- targetName
- String
Имя вызываемого метода.
- arguments
- IReadOnlyList<Object>
Аргументы для передачи в вызываемый метод. Если задано значение NULL, аргументы не передаются.
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
- isParameterObject
- Boolean
Значение, указывающее, следует ли передавать параметр в качестве объекта.
Возвращаемое значение
Задача, результатом которой является десериализованный ответ с сервера JSON-RPC.
Применяется к
InvokeCoreAsync<TResult>(Nullable<Int64>, String, IReadOnlyList<Object>, CancellationToken, Boolean)
Внимание!
Use the InvokeCoreAsync(RequestId, ...) overload instead.
Вызывает заданный метод на сервере JSON-RPC.
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.")]
protected System.Threading.Tasks.Task<TResult> InvokeCoreAsync<TResult> (long? id, string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments, System.Threading.CancellationToken cancellationToken, bool isParameterObject);
member this.InvokeCoreAsync : Nullable<int64> * string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken * bool -> System.Threading.Tasks.Task<'Result>
[<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.
Параметры
Идентификатор, установленный клиентом. Если задано значение по умолчанию, предполагается, что оно является уведомлением.
- targetName
- String
Имя вызываемого метода. Не должен иметь значение NULL или быть пустым.
- arguments
- IReadOnlyList<Object>
Аргументы для передачи в вызываемый метод. Они должны быть сериализуемыми с помощью выбранного.IJsonRpcMessageFormatter Если null
аргументы не передаются.
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
- isParameterObject
- Boolean
Значение, указывающее, следует ли передавать параметр в качестве объекта.
Возвращаемое значение
Задача, результатом которой является десериализованный ответ с сервера JSON-RPC.
- Атрибуты
Применяется к
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
содержать элементов.
Это значение игнорируется при isParameterObject
значении true.
- namedArgumentDeclaredTypes
- IReadOnlyDictionary<String,Type>
Словарь Type объектов, описывающих способ ввода каждой записи в IReadOnlyDictionary<TKey,TValue> предоставленном в единственном элементе arguments
сервера.
Если этот параметр указан, он должен иметь точно такой же набор ключей, что и словарь, содержащийся в первом элементе , и не null
содержать значенийarguments
.
- cancellationToken
- CancellationToken
Токен, отмена которого должна сигнализировать серверу прекратить обработку этого запроса.
- isParameterObject
- Boolean
Значение, указывающее, следует ли передавать параметр в качестве объекта.
Возвращаемое значение
Задача, которая завершается ответом с сервера JSON-RPC.
Исключения
Вызывается после cancellationToken
отмены.
Если запрос уже передан, исключение создается только после того, как сервер получил уведомление об отмене и ответил на него.
Если сервер завершает запрос вместо отмены, это исключение не будет создано.
Когда подключение удаляется перед получением ответа, это исключение возникает, если cancellationToken
он был отменен.
Общий базовый класс для различных исключений RPC, которые могут вызываться. Некоторые распространенные производные типы перечислены по отдельности.
Возникает при возвращении ошибки с сервера в результате выполнения запрошенного метода.
Возникает, когда сервер сообщает, что для вызова не найден соответствующий метод.
Если targetName
значение равно NULL.
Возникает, когда targetName
пусто.
Если этот экземпляр JsonRpc уже удален до этого вызова.
Возникает при завершении подключения (по обе стороны) перед запросом или во время выполнения запроса, если cancellationToken
он еще не сигнализирует.
Любое исключение, вызванное IJsonRpcMessageFormatter (как правило, из-за сбоев сериализации). При использовании JsonMessageFormatter это должно быть Newtonsoft.Json.JsonSerializationException. При использовании MessagePackFormatter это должно быть MessagePack.MessagePackSerializationException.