JsonRpc.InvokeWithCancellationAsync Method

Reference

Definition

Namespace:: StreamJsonRpc

Assembly:: StreamJsonRpc.dll

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

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

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

InvokeWithCancellationAsync(String, IReadOnlyList<Object>, IReadOnlyList<Type>, CancellationToken)	Invokes a given method on a JSON-RPC server.
InvokeWithCancellationAsync(String, IReadOnlyList<Object>, CancellationToken)	Invokes a given method on a JSON-RPC server.
InvokeWithCancellationAsync<TResult>(String, IReadOnlyList<Object>, CancellationToken)	Invokes a given method on a JSON-RPC server.
InvokeWithCancellationAsync<TResult>(String, IReadOnlyList<Object>, IReadOnlyList<Type>, CancellationToken)	Invokes a given method on a JSON-RPC server.

InvokeWithCancellationAsync(String, IReadOnlyList<Object>, IReadOnlyList<Type>, CancellationToken)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task InvokeWithCancellationAsync (string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments, System.Collections.Generic.IReadOnlyList<Type> argumentDeclaredTypes, System.Threading.CancellationToken cancellationToken);

member this.InvokeWithCancellationAsync : string * System.Collections.Generic.IReadOnlyList<obj> * System.Collections.Generic.IReadOnlyList<Type> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function InvokeWithCancellationAsync (targetName As String, arguments As IReadOnlyList(Of Object), argumentDeclaredTypes As IReadOnlyList(Of Type), cancellationToken As CancellationToken) As Task

Parameters

targetName: String

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

arguments: IReadOnlyList<Object>

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

argumentDeclaredTypes: IReadOnlyList<Type>

cancellationToken: CancellationToken

The token whose cancellation should signal the server to stop processing this request.

Returns

Task

A task that completes with the response from the JSON-RPC server.

Applies to

InvokeWithCancellationAsync(String, IReadOnlyList<Object>, CancellationToken)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task InvokeWithCancellationAsync (string targetName, System.Collections.Generic.IReadOnlyList<object> arguments = default, System.Threading.CancellationToken cancellationToken = default);

public System.Threading.Tasks.Task InvokeWithCancellationAsync (string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments = default, System.Threading.CancellationToken cancellationToken = default);

member this.InvokeWithCancellationAsync : string * System.Collections.Generic.IReadOnlyList<obj> * System.Threading.CancellationToken -> System.Threading.Tasks.Task

Public Function InvokeWithCancellationAsync (targetName As String, Optional arguments As IReadOnlyList(Of Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task

Parameters

targetName: String

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

arguments: IReadOnlyList<Object>

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

cancellationToken: CancellationToken

The token whose cancellation should signal the server to stop processing this request.

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 result gets back from the server or in response to the cancellationToken being canceled.

RemoteInvocationException

Result task fails with this exception if the server method throws an exception, which may occur in response to the cancellationToken being canceled.

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

InvokeWithCancellationAsync<TResult>(String, IReadOnlyList<Object>, CancellationToken)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task<TResult> InvokeWithCancellationAsync<TResult> (string targetName, System.Collections.Generic.IReadOnlyList<object> arguments = default, System.Threading.CancellationToken cancellationToken = default);

public System.Threading.Tasks.Task<TResult> InvokeWithCancellationAsync<TResult> (string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Function InvokeWithCancellationAsync(Of TResult) (targetName As String, Optional arguments As IReadOnlyList(Of Object) = Nothing, Optional cancellationToken As CancellationToken = Nothing) 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: IReadOnlyList<Object>

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

cancellationToken: CancellationToken

The token whose cancellation should signal the server to stop processing this request.

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 or in response to the cancellationToken being canceled.

RemoteInvocationException

Result task fails with this exception if the server method throws an exception, which may occur in response to the cancellationToken being canceled.

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

InvokeWithCancellationAsync<TResult>(String, IReadOnlyList<Object>, IReadOnlyList<Type>, CancellationToken)

Invokes a given method on a JSON-RPC server.

public System.Threading.Tasks.Task<TResult> InvokeWithCancellationAsync<TResult> (string targetName, System.Collections.Generic.IReadOnlyList<object?>? arguments, System.Collections.Generic.IReadOnlyList<Type>? argumentDeclaredTypes, System.Threading.CancellationToken cancellationToken);

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

Public Function InvokeWithCancellationAsync(Of TResult) (targetName As String, arguments As IReadOnlyList(Of Object), argumentDeclaredTypes As IReadOnlyList(Of Type), cancellationToken As CancellationToken) 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: IReadOnlyList<Object>

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

argumentDeclaredTypes: IReadOnlyList<Type>

A list of Type objects that describe how each element in arguments is expected by the server to be typed. If specified, this must have exactly the same length as arguments and contain no null elements. This value is ignored when isParameterObject is true.

cancellationToken: CancellationToken

The token whose cancellation should signal the server to stop processing this request.

Returns

Task<TResult>

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

Applies to

JsonRpc.InvokeWithCancellationAsync Method

Definition

Overloads

InvokeWithCancellationAsync(String, IReadOnlyList<Object>, IReadOnlyList<Type>, CancellationToken)

Parameters

Returns

Applies to

InvokeWithCancellationAsync(String, IReadOnlyList<Object>, CancellationToken)

Parameters

Returns

Exceptions

Applies to

InvokeWithCancellationAsync<TResult>(String, IReadOnlyList<Object>, CancellationToken)

Type Parameters

Parameters

Returns

Exceptions

Applies to

InvokeWithCancellationAsync<TResult>(String, IReadOnlyList<Object>, IReadOnlyList<Type>, CancellationToken)

Type Parameters

Parameters

Returns

Applies to

Additional resources