JsonRpc.InvokeAsync Method

Reference

Definition

Namespace:: StreamJsonRpc

Assembly:: StreamJsonRpc.dll

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacman64817\StreamJsonRpc.1.3.23

Package:: streamjsonrpc vD:\a\1\s\dotnet\nue-out\_pacmane8f73\StreamJsonRpc.1.5.68

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

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

InvokeAsync(String, Object[])	Invokes a given method on a JSON-RPC server.
InvokeAsync(String, Object)	Invokes a given method on a JSON-RPC server.
InvokeAsync<TResult>(String, Object)	Invokes a given method on a JSON-RPC server.
InvokeAsync<TResult>(String, Object[])	Invokes a given method on a JSON-RPC server.

InvokeAsync(String, Object[])

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task InvokeAsync (string targetName, params object[] arguments);

public System.Threading.Tasks.Task InvokeAsync (string targetName, params object?[]? arguments);

member this.InvokeAsync : string * obj[] -> System.Threading.Tasks.Task

Public Function InvokeAsync (targetName As String, ParamArray arguments As Object()) As Task

Parameters

targetName: String

Name of the method to invoke. Must not be null or empty.

arguments: Object[]

Arguments to pass to the invoked method. They must be serializable using the selected IJsonRpcMessageFormatter. If null, no arguments are passed.

Returns

Task

A task that completes when the server method executes.

Exceptions

OperationCanceledException

Result task fails with this exception if the communication channel ends before the server indicates completion of the method.

RemoteInvocationException

Result task fails with this exception if the server method throws an exception.

RemoteMethodNotFoundException

Result task fails with this exception if the targetName method has not been registered on the server.

ArgumentNullException

If targetName is null.

ObjectDisposedException

If this instance of JsonRpc has been disposed.

RemoteTargetNotSetException

Result task fails with this exception if the server has no target object.

Applies to

InvokeAsync(String, Object)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task InvokeAsync (string targetName, object argument);

public System.Threading.Tasks.Task InvokeAsync (string targetName, object? argument);

member this.InvokeAsync : string * obj -> System.Threading.Tasks.Task

Public Function InvokeAsync (targetName As String, argument As Object) As Task

Parameters

targetName: String

Name of the method to invoke. Must not be null or empty.

argument: Object

A single method argument, must be serializable using the selected IJsonRpcMessageFormatter.

Returns

Task

A task that completes when the server method executes.

Exceptions

OperationCanceledException

Result task fails with this exception if the communication channel ends before the server indicates completion of the method.

RemoteInvocationException

Result task fails with this exception if the server method throws an exception.

RemoteMethodNotFoundException

Result task fails with this exception if the targetName method has not been registered on the server.

ArgumentNullException

If targetName is null.

ObjectDisposedException

If this instance of JsonRpc has been disposed.

RemoteTargetNotSetException

Result task fails with this exception if the server has no target object.

Applies to

InvokeAsync<TResult>(String, Object)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task<TResult> InvokeAsync<TResult> (string targetName, object argument);

public System.Threading.Tasks.Task<TResult> InvokeAsync<TResult> (string targetName, object? argument);

member this.InvokeAsync : string * obj -> System.Threading.Tasks.Task<'Result>

Public Function InvokeAsync(Of TResult) (targetName As String, argument As Object) As Task(Of TResult)

Type Parameters

TResult

Type of the method result.

Parameters

targetName: String

Name of the method to invoke. Must not be null or empty.

argument: Object

A single method argument, must be serializable using the selected IJsonRpcMessageFormatter.

Returns

Task<TResult>

A task that completes when the server method executes and returns the result.

Exceptions

OperationCanceledException

Result task fails with this exception if the communication channel ends before the result gets back from the server.

RemoteInvocationException

Result task fails with this exception if the server method throws an exception.

RemoteMethodNotFoundException

Result task fails with this exception if the targetName method has not been registered on the server.

ArgumentNullException

If targetName is null.

ObjectDisposedException

If this instance of JsonRpc has been disposed.

RemoteTargetNotSetException

Result task fails with this exception if the server has no target object.

Applies to

InvokeAsync<TResult>(String, Object[])

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task<TResult> InvokeAsync<TResult> (string targetName, params object[] arguments);

public System.Threading.Tasks.Task<TResult> InvokeAsync<TResult> (string targetName, params object?[]? arguments);

member this.InvokeAsync : string * obj[] -> System.Threading.Tasks.Task<'Result>

Public Function InvokeAsync(Of TResult) (targetName As String, ParamArray arguments As Object()) As Task(Of TResult)

Type Parameters

TResult

Type of the method result.

Parameters

targetName: String

Name of the method to invoke. Must not be null or empty.

arguments: Object[]

Arguments to pass to the invoked method. They must be serializable using the selected IJsonRpcMessageFormatter. If null, no arguments are passed.

Returns

Task<TResult>

A task that completes when the server method executes and returns the result.

Exceptions

OperationCanceledException

Result task fails with this exception if the communication channel ends before the result gets back from the server.

RemoteInvocationException

Result task fails with this exception if the server method throws an exception.

RemoteMethodNotFoundException

Result task fails with this exception if the targetName method has not been registered on the server.

ArgumentNullException

If targetName is null.

ObjectDisposedException

If this instance of JsonRpc has been disposed.

RemoteTargetNotSetException

Result task fails with this exception if the server has no target object.

Applies to

JsonRpc.InvokeAsync Method

Definition

Overloads

InvokeAsync(String, Object[])

Parameters

Returns

Exceptions

Applies to

InvokeAsync(String, Object)

Parameters

Returns

Exceptions

Applies to

InvokeAsync<TResult>(String, Object)

Type Parameters

Parameters

Returns

Exceptions

Applies to

InvokeAsync<TResult>(String, Object[])

Type Parameters

Parameters

Returns

Exceptions

Applies to

Additional resources