JsonRpc.NotifyAsync 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

Overloads

NotifyAsync(String, Object)

Invokes a given method on a JSON-RPC server without waiting for its response.
NotifyAsync(String, Object[])

Invoke a method on the server and don't wait for its completion, fire-and-forget style.
NotifyAsync(String, Object[], IReadOnlyList<Type>)

Invokes a given method on a JSON-RPC server without waiting for its response.

NotifyAsync(String, Object)

Invokes a given method on a JSON-RPC server without waiting for its response.

public System.Threading.Tasks.Task NotifyAsync (string targetName, object argument);
public System.Threading.Tasks.Task NotifyAsync (string targetName, object? argument);
member this.NotifyAsync : string * obj -> System.Threading.Tasks.Task
Public Function NotifyAsync (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

Method argument, must be serializable using the selected IJsonRpcMessageFormatter.

Returns

Task

A task that completes when the notify request is sent to the channel to the server.

Exceptions

ArgumentNullException

If targetName is null.

ArgumentException

Thrown when targetName is empty.

ObjectDisposedException

If this instance of JsonRpc has already been disposed prior to this call.

ConnectionLostException

Thrown when the connection is terminated (by either side) while the request is being transmitted.

Exception

Any exception thrown by the IJsonRpcMessageFormatter (typically due to serialization failures). When using JsonMessageFormatter this should be Newtonsoft.Json.JsonSerializationException. When using MessagePackFormatter this should be MessagePack.MessagePackSerializationException.

Remarks

Any error that happens on the server side is ignored.

Applies to

NotifyAsync(String, Object[])

Invoke a method on the server and don't wait for its completion, fire-and-forget style.

public System.Threading.Tasks.Task NotifyAsync (string targetName, params object[] arguments);
public System.Threading.Tasks.Task NotifyAsync (string targetName, params object?[]? arguments);
member this.NotifyAsync : string * obj[] -> System.Threading.Tasks.Task
Public Function NotifyAsync (targetName As String, ParamArray arguments As Object()) As Task

Parameters

targetName
String

The name of the method to invoke on the server. Must not be null or empty string.

arguments
Object[]

Method arguments, must be serializable to JSON.

Returns

Task

A task that completes when the notify request is sent to the channel to the server.

Exceptions

ArgumentNullException

If targetName is null.

ObjectDisposedException

If this instance of JsonRpc has been disposed.

Remarks

Any error that happens on the server side is ignored.

Applies to

NotifyAsync(String, Object[], IReadOnlyList<Type>)

Invokes a given method on a JSON-RPC server without waiting for its response.

public System.Threading.Tasks.Task NotifyAsync (string targetName, object?[]? arguments, System.Collections.Generic.IReadOnlyList<Type>? argumentDeclaredTypes);
member this.NotifyAsync : string * obj[] * System.Collections.Generic.IReadOnlyList<Type> -> System.Threading.Tasks.Task
Public Function NotifyAsync (targetName As String, arguments As Object(), argumentDeclaredTypes As IReadOnlyList(Of Type)) 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.

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.

Returns

Task

A task that completes when the notify request is sent to the channel to the server.

Remarks

Any error that happens on the server side is ignored.

Applies to