-
Notifications
You must be signed in to change notification settings - Fork 149
/
JsonRpc.cs
2632 lines (2346 loc) · 152 KB
/
JsonRpc.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
namespace StreamJsonRpc
{
using System;
using System.Buffers;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Threading;
using System.Threading.Tasks;
using Microsoft;
using Microsoft.VisualStudio.Threading;
using Newtonsoft.Json;
using StreamJsonRpc.Protocol;
using StreamJsonRpc.Reflection;
/// <summary>
/// Manages a JSON-RPC connection with another entity over a <see cref="Stream"/>.
/// </summary>
public class JsonRpc : IDisposableObservable, IJsonRpcFormatterCallbacks, IJsonRpcTracingCallbacks
{
/// <summary>
/// The <see cref="System.Threading.SynchronizationContext"/> to use to schedule work on the threadpool.
/// </summary>
internal static readonly SynchronizationContext DefaultSynchronizationContext = new SynchronizationContext();
private static readonly MethodInfo MarshalWithControlledLifetimeOpenGenericMethodInfo = typeof(JsonRpc).GetMethods(BindingFlags.Static | BindingFlags.NonPublic).Single(m => m.Name == nameof(MarshalWithControlledLifetime) && m.IsGenericMethod);
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly object syncObject = new object();
/// <summary>
/// The object to lock when accessing the <see cref="resultDispatcherMap"/>.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly object dispatcherMapLock = new object();
/// <summary>
/// The object to lock when accessing the <see cref="DisconnectedPrivate"/> member.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly object disconnectedEventLock = new object();
/// <summary>
/// A map of outbound calls awaiting responses.
/// Lock the <see cref="dispatcherMapLock"/> object for all access to this member.
/// </summary>
private readonly Dictionary<RequestId, OutstandingCallData> resultDispatcherMap = new Dictionary<RequestId, OutstandingCallData>();
/// <summary>
/// A delegate for the <see cref="CancelPendingOutboundRequest"/> method.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly Action<object> cancelPendingOutboundRequestAction;
/// <summary>
/// The source for the <see cref="DisconnectedToken"/> property.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
#pragma warning disable CA2213 // Disposable fields should be disposed
private readonly CancellationTokenSource disconnectedSource = new CancellationTokenSource();
#pragma warning restore CA2213 // Disposable fields should be disposed
/// <summary>
/// The completion source behind <see cref="Completion"/>.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly TaskCompletionSource<bool> completionSource = new TaskCompletionSource<bool>();
/// <summary>
/// Backing field for the <see cref="DispatchCompletion"/> property.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private readonly AsyncManualResetEvent dispatchCompletionSource = new AsyncManualResetEvent(initialState: true);
/// <summary>
/// Tracks RPC target objects.
/// </summary>
private readonly RpcTargetInfo rpcTargetInfo;
/// <summary>
/// List of remote RPC targets to call if connection should be relayed.
/// </summary>
private ImmutableList<JsonRpc> remoteRpcTargets = ImmutableList<JsonRpc>.Empty;
private Task? readLinesTask;
private long nextId = 1;
private int requestsInDispatchCount;
private JsonRpcDisconnectedEventArgs? disconnectedEventArgs;
/// <summary>
/// Backing field for the <see cref="TraceSource"/> property.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private TraceSource traceSource = new TraceSource(nameof(JsonRpc), SourceLevels.ActivityTracing | SourceLevels.Warning);
/// <summary>
/// Backing field for the <see cref="CancelLocallyInvokedMethodsWhenConnectionIsClosed"/> property.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private bool cancelLocallyInvokedMethodsWhenConnectionIsClosed;
/// <summary>
/// Backing field for the <see cref="SynchronizationContext"/> property.
/// </summary>
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
private SynchronizationContext? synchronizationContext;
/// <summary>
/// Backing field for the <see cref="CancellationStrategy"/> property.
/// </summary>
private ICancellationStrategy? cancellationStrategy;
/// <summary>
/// Backing field for the <see cref="ActivityTracingStrategy"/> property.
/// </summary>
private IActivityTracingStrategy? activityTracingStrategy;
/// <summary>
/// Backing field for <see cref="ExceptionStrategy"/>.
/// </summary>
private ExceptionProcessing exceptionStrategy;
/// <summary>
/// Backing field for <see cref="ExceptionOptions"/>.
/// </summary>
private ExceptionSettings exceptionSettings = ExceptionSettings.UntrustedData;
/// <summary>
/// Backing field for the <see cref="IJsonRpcFormatterCallbacks.RequestTransmissionAborted"/> event.
/// </summary>
private EventHandler<JsonRpcMessageEventArgs>? requestTransmissionAborted;
/// <summary>
/// Backing field for the <see cref="IJsonRpcFormatterCallbacks.ResponseReceived"/> event.
/// </summary>
private EventHandler<JsonRpcResponseEventArgs>? responseReceived;
/// <summary>
/// Backing field for the <see cref="IJsonRpcFormatterCallbacks.ResponseSent"/> event.
/// </summary>
private EventHandler<JsonRpcResponseEventArgs>? responseSent;
/// <summary>
/// Initializes a new instance of the <see cref="JsonRpc"/> class that uses
/// <see cref="HeaderDelimitedMessageHandler"/> around messages serialized using the
/// <see cref="JsonMessageFormatter"/>.
/// </summary>
/// <param name="stream">The full duplex stream used to transmit and receive messages.</param>
/// <remarks>
/// It is important to call <see cref="StartListening"/> to begin receiving messages.
/// </remarks>
public JsonRpc(Stream stream)
#pragma warning disable CA2000 // Dispose objects before losing scope
: this(new HeaderDelimitedMessageHandler(Requires.NotNull(stream, nameof(stream)), stream, new JsonMessageFormatter()))
#pragma warning restore CA2000 // Dispose objects before losing scope
{
}
/// <summary>
/// Initializes a new instance of the <see cref="JsonRpc"/> class that uses
/// <see cref="HeaderDelimitedMessageHandler"/> around messages serialized using the
/// <see cref="JsonMessageFormatter"/>.
/// </summary>
/// <param name="sendingStream">The stream used to transmit messages. May be null.</param>
/// <param name="receivingStream">The stream used to receive messages. May be null.</param>
/// <param name="target">An optional target object to invoke when incoming RPC requests arrive.</param>
/// <remarks>
/// It is important to call <see cref="StartListening"/> to begin receiving messages.
/// </remarks>
public JsonRpc(Stream? sendingStream, Stream? receivingStream, object? target = null)
#pragma warning disable CA2000 // Dispose objects before losing scope
: this(new HeaderDelimitedMessageHandler(sendingStream, receivingStream, new JsonMessageFormatter()))
#pragma warning restore CA2000 // Dispose objects before losing scope
{
if (target is not null)
{
this.AddLocalRpcTarget(target);
}
}
/// <summary>
/// Initializes a new instance of the <see cref="JsonRpc"/> class.
/// </summary>
/// <param name="messageHandler">The message handler to use to transmit and receive RPC messages.</param>
/// <param name="target">An optional target object to invoke when incoming RPC requests arrive.</param>
/// <remarks>
/// It is important to call <see cref="StartListening"/> to begin receiving messages.
/// </remarks>
public JsonRpc(IJsonRpcMessageHandler messageHandler, object? target)
: this(messageHandler)
{
if (target is not null)
{
this.AddLocalRpcTarget(target);
}
}
/// <summary>
/// Initializes a new instance of the <see cref="JsonRpc"/> class.
/// </summary>
/// <param name="messageHandler">The message handler to use to transmit and receive RPC messages.</param>
/// <remarks>
/// It is important to call <see cref="StartListening"/> to begin receiving messages.
/// </remarks>
public JsonRpc(IJsonRpcMessageHandler messageHandler)
{
Requires.NotNull(messageHandler, nameof(messageHandler));
this.rpcTargetInfo = new RpcTargetInfo(this);
if (messageHandler.Formatter is IJsonRpcInstanceContainer formatter)
{
formatter.Rpc = this;
}
this.cancelPendingOutboundRequestAction = this.CancelPendingOutboundRequest;
this.MessageHandler = messageHandler;
// Default to preserving order of incoming messages since so many users assume this is the behavior.
// If ordering is not required and higher throughput is desired, the owner of this instance can clear this property
// so that all incoming messages are queued to the threadpool, allowing immediate concurrency.
this.SynchronizationContext = new NonConcurrentSynchronizationContext(sticky: false);
this.CancellationStrategy = new StandardCancellationStrategy(this);
}
/// <summary>
/// Raised when the underlying stream is disconnected.
/// </summary>
public event EventHandler<JsonRpcDisconnectedEventArgs>? Disconnected
{
add
{
JsonRpcDisconnectedEventArgs? disconnectedArgs;
lock (this.disconnectedEventLock)
{
disconnectedArgs = this.disconnectedEventArgs;
if (disconnectedArgs is null)
{
this.DisconnectedPrivate += value;
}
}
if (disconnectedArgs is not null)
{
value?.Invoke(this, disconnectedArgs);
}
}
remove
{
this.DisconnectedPrivate -= value;
}
}
/// <inheritdoc/>
event EventHandler<JsonRpcMessageEventArgs> IJsonRpcFormatterCallbacks.RequestTransmissionAborted
{
add => this.requestTransmissionAborted += value;
remove => this.requestTransmissionAborted -= value;
}
/// <inheritdoc/>
event EventHandler<JsonRpcResponseEventArgs> IJsonRpcFormatterCallbacks.ResponseReceived
{
add => this.responseReceived += value;
remove => this.responseReceived -= value;
}
/// <inheritdoc/>
event EventHandler<JsonRpcResponseEventArgs> IJsonRpcFormatterCallbacks.ResponseSent
{
add => this.responseSent += value;
remove => this.responseSent -= value;
}
private event EventHandler<JsonRpcDisconnectedEventArgs>? DisconnectedPrivate;
/// <summary>
/// Event IDs raised to our <see cref="TraceSource"/>.
/// </summary>
#pragma warning disable CA1717 // Only FlagsAttribute enums should have plural names
public enum TraceEvents
#pragma warning restore CA1717 // Only FlagsAttribute enums should have plural names
{
/// <summary>
/// Occurs when a local RPC method is added to our mapping table.
/// </summary>
LocalMethodAdded,
/// <summary>
/// Occurs when a candidate local RPC method is NOT added to our mapping table.
/// </summary>
LocalMethodNotAdded,
/// <summary>
/// Occurs when an event handler subscribes to an event on an added target object.
/// </summary>
LocalEventListenerAdded,
/// <summary>
/// Occurs when this instance starts listening for incoming RPC messages.
/// </summary>
ListeningStarted,
/// <summary>
/// Occurs when a notification arrives that is attempting to cancel a prior request.
/// </summary>
ReceivedCancellation,
/// <summary>
/// Occurs when a JSON-RPC request or notification was received, but no local method is found to invoke for it.
/// </summary>
RequestWithoutMatchingTarget,
/// <summary>
/// Occurs when a <see cref="JsonRpcRequest"/> is received.
/// </summary>
RequestReceived,
/// <summary>
/// Occurs when any <see cref="JsonRpcMessage"/> is received.
/// At <see cref="System.Diagnostics.TraceLevel.Info"/>, <see cref="TraceListener.TraceData(TraceEventCache, string, TraceEventType, int, object)"/>
/// is invoked with the <see cref="JsonRpcMessage"/> that is received.
/// At <see cref="System.Diagnostics.TraceLevel.Verbose"/>, <see cref="TraceListener.TraceEvent(TraceEventCache, string, TraceEventType, int, string, object[])"/>
/// is invoked with the JSON representation of the message.
/// </summary>
MessageReceived,
/// <summary>
/// Occurs when any <see cref="JsonRpcMessage"/> is transmitted.
/// At <see cref="System.Diagnostics.TraceLevel.Info"/>, <see cref="TraceListener.TraceData(TraceEventCache, string, TraceEventType, int, object)"/>
/// is invoked with the <see cref="JsonRpcMessage"/> that is transmitted.
/// At <see cref="System.Diagnostics.TraceLevel.Verbose"/>, <see cref="TraceListener.TraceEvent(TraceEventCache, string, TraceEventType, int, string, object[])"/>
/// is invoked with the JSON representation of the message.
/// </summary>
MessageSent,
/// <summary>
/// Occurs when a <see cref="JsonRpcRequest"/> is received and successfully mapped to a local method to be invoked.
/// </summary>
LocalInvocation,
/// <summary>
/// Occurs when a locally invoked method from a <see cref="JsonRpcRequest"/> throws an exception (or returns a faulted <see cref="Task"/>).
/// <see cref="TraceListener.TraceData(TraceEventCache, string, TraceEventType, int, object[])"/> is invoked with the thrown <see cref="Exception"/>, request method name, request ID, and the argument object/array.
/// <see cref="TraceListener.TraceEvent(TraceEventCache, string, TraceEventType, int, string, object[])"/> is invoked with a text message formatted with exception information.
/// </summary>
LocalInvocationError,
/// <summary>
/// Occurs when a successful result message for a prior invocation is received.
/// </summary>
ReceivedResult,
/// <summary>
/// Occurs when an error message for a prior invocation is received.
/// </summary>
ReceivedError,
/// <summary>
/// Occurs when the connection is closed.
/// </summary>
Closed,
/// <summary>
/// A local request is canceled because the remote party terminated the connection.
/// </summary>
RequestAbandonedByRemote,
/// <summary>
/// An extensibility point was leveraged locally and broke the contract.
/// </summary>
LocalContractViolation,
/// <summary>
/// An exception occurred when reading or writing the $/progress notification.
/// </summary>
ProgressNotificationError,
/// <summary>
/// An incoming RPC call included an argument that failed to deserialize to the type on a candidate target method's proposed matching parameter.
/// </summary>
/// <remarks>
/// This may not represent a fatal error. When there are multiple overloads to choose from,
/// choosing the overload to invoke involves attempts to deserialize arguments to the types dictated by each overload's parameters.
/// Thus a failure recorded in this event may be followed by a successful deserialization to another parameter type and invocation of a different overload.
/// </remarks>
MethodArgumentDeserializationFailure,
/// <summary>
/// An outgoing RPC message was not sent due to an exception, possibly a serialization failure.
/// </summary>
TransmissionFailed,
/// <summary>
/// An incoming <see cref="Exception"/> cannot be deserialized to its original type because the type could not be loaded.
/// </summary>
ExceptionTypeNotFound,
/// <summary>
/// An instance of an <see cref="Exception"/>-derived type was serialized as its base type because it did not have the <see cref="SerializableAttribute"/> applied.
/// </summary>
ExceptionNotSerializable,
/// <summary>
/// An <see cref="Exception"/>-derived type could not be deserialized because it was missing a deserializing constructor.
/// A base-type that <em>does</em> offer the constructor will be instantiated instead.
/// </summary>
ExceptionNotDeserializable,
}
/// <summary>
/// Gets or sets the <see cref="System.Threading.SynchronizationContext"/> to use when invoking methods requested by the remote party.
/// </summary>
/// <value>Defaults to null.</value>
/// <remarks>
/// When not specified, methods are invoked on the threadpool.
/// </remarks>
public SynchronizationContext? SynchronizationContext
{
get => this.synchronizationContext;
set
{
this.ThrowIfConfigurationLocked();
this.synchronizationContext = value;
}
}
/// <summary>
/// Gets a <see cref="Task"/> that completes when this instance is disposed or when listening has stopped
/// whether by error, disposal or the stream closing.
/// </summary>
/// <remarks>
/// <para>
/// The returned <see cref="Task"/> may transition to a faulted state
/// for exceptions fatal to the protocol or this instance.
/// </para>
/// <para>
/// When local RPC target objects or methods have been added, those methods may still be running from prior RPC requests
/// when this property completes. Track their completion with the <see cref="DispatchCompletion"/> property.
/// </para>
/// </remarks>
public Task Completion
{
get
{
return this.completionSource.Task;
}
}
/// <summary>
/// Gets a <see cref="Task"/> that completes when no local target methods are executing from an RPC call.
/// </summary>
/// <remarks>
/// If the JSON-RPC connection is still active when retrieving this property's value, the returned <see cref="Task"/> will complete
/// when no local dispatches are in progress, even if the connection is still active.
/// Retrieving the property after a previously obtained <see cref="Task"/> has completed will result in a new, incomplete <see cref="Task"/> if incoming requests are currently in dispatch.
/// </remarks>
public Task DispatchCompletion => this.dispatchCompletionSource.WaitAsync();
/// <summary>
/// Gets or sets a value indicating whether configuration of this instance
/// can be changed after <see cref="StartListening"/> or <see cref="Attach(Stream, object)"/>
/// has been called.
/// </summary>
/// <value>The default is <c>false</c>.</value>
/// <remarks>
/// By default, all configuration such as target objects and target methods must be set
/// before listening starts to avoid a race condition whereby we receive a method invocation
/// message before we have wired up a handler for it and must reject the call.
/// But in some advanced scenarios, it may be necessary to add target methods after listening
/// has started (e.g. in response to an invocation that enables additional functionality),
/// in which case setting this property to <c>true</c> is appropriate.
/// </remarks>
public bool AllowModificationWhileListening { get; set; }
/// <inheritdoc />
public bool IsDisposed { get; private set; }
/// <summary>
/// Gets or sets a value indicating whether to cancel all methods dispatched locally
/// that accept a <see cref="CancellationToken"/> when the connection with the remote party is closed.
/// </summary>
public bool CancelLocallyInvokedMethodsWhenConnectionIsClosed
{
get => this.cancelLocallyInvokedMethodsWhenConnectionIsClosed;
set
{
// We don't typically allow changing this setting after listening has started because
// it would not have applied to requests that have already come in. Folks should opt in
// to that otherwise non-deterministic behavior, or simply set it before listening starts.
this.ThrowIfConfigurationLocked();
this.cancelLocallyInvokedMethodsWhenConnectionIsClosed = value;
}
}
/// <summary>
/// Gets or sets the <see cref="System.Diagnostics.TraceSource"/> used to trace JSON-RPC messages and events.
/// </summary>
/// <value>The value can never be null.</value>
/// <exception cref="ArgumentNullException">Thrown by the setter if a null value is provided.</exception>
public TraceSource TraceSource
{
get => this.traceSource;
set
{
Requires.NotNull(value, nameof(value));
this.traceSource = value;
}
}
/// <summary>
/// Gets or sets the cancellation strategy to use.
/// </summary>
/// <value>The default value is the <see cref="StandardCancellationStrategy"/> which uses the "$/cancelRequest" notification.</value>
/// <inheritdoc cref="ThrowIfConfigurationLocked" path="/exception"/>
public ICancellationStrategy? CancellationStrategy
{
get => this.cancellationStrategy;
set
{
this.ThrowIfConfigurationLocked();
this.cancellationStrategy = value;
}
}
/// <summary>
/// Gets or sets a value indicating whether exceptions thrown by the RPC server should be fully serialized
/// for the RPC client to then deserialize.
/// </summary>
/// <value>The default value is <see cref="ExceptionProcessing.CommonErrorData"/>.</value>
/// <remarks>
/// This setting influences the implementations of error processing virtual methods on this class.
/// When those methods are overridden by a derived type, this property may have different or no impact on behavior.
/// This does not alter how <see cref="LocalRpcException"/> behaves when thrown, since that exception type supplies all the details of the error response directly.
/// </remarks>
public ExceptionProcessing ExceptionStrategy
{
get => this.exceptionStrategy;
set
{
this.ThrowIfConfigurationLocked();
this.exceptionStrategy = value;
}
}
/// <summary>
/// Gets or sets the settings to use for serializing/deserializing exceptions.
/// </summary>
public ExceptionSettings ExceptionOptions
{
get => this.exceptionSettings;
set
{
Requires.NotNull(value, nameof(value));
this.ThrowIfConfigurationLocked();
this.exceptionSettings = value;
}
}
/// <summary>
/// Gets or sets the strategy for propagating activity IDs over RPC.
/// </summary>
public IActivityTracingStrategy? ActivityTracingStrategy
{
get => this.activityTracingStrategy;
set
{
this.ThrowIfConfigurationLocked();
this.activityTracingStrategy = value;
}
}
/// <summary>
/// Gets the message handler used to send and receive messages.
/// </summary>
internal IJsonRpcMessageHandler MessageHandler { get; }
/// <summary>
/// Gets a token that is cancelled when the connection is lost.
/// </summary>
internal CancellationToken DisconnectedToken => this.disconnectedSource.Token;
/// <summary>
/// Gets the user-specified <see cref="SynchronizationContext"/> or a default instance that will execute work on the threadpool.
/// </summary>
internal SynchronizationContext SynchronizationContextOrDefault => this.SynchronizationContext ?? DefaultSynchronizationContext;
/// <summary>
/// Gets a value indicating whether listening has started.
/// </summary>
private bool HasListeningStarted => this.readLinesTask is not null;
/// <summary>
/// Initializes a new instance of the <see cref="JsonRpc"/> class that uses
/// <see cref="HeaderDelimitedMessageHandler"/> around messages serialized using the
/// <see cref="JsonMessageFormatter"/>, and immediately starts listening.
/// </summary>
/// <param name="stream">A bidirectional stream to send and receive RPC messages on.</param>
/// <param name="target">An optional target object to invoke when incoming RPC requests arrive.</param>
/// <returns>The initialized and listening <see cref="JsonRpc"/> object.</returns>
#pragma warning disable RS0027 // Public API with optional parameter(s) should have the most parameters amongst its public overloads.
public static JsonRpc Attach(Stream stream, object? target = null)
#pragma warning restore RS0027 // Public API with optional parameter(s) should have the most parameters amongst its public overloads.
{
Requires.NotNull(stream, nameof(stream));
return Attach(stream, stream, target);
}
/// <summary>
/// Initializes a new instance of the <see cref="JsonRpc"/> class that uses
/// <see cref="HeaderDelimitedMessageHandler"/> around messages serialized using the
/// <see cref="JsonMessageFormatter"/>, and immediately starts listening.
/// </summary>
/// <param name="sendingStream">The stream used to transmit messages. May be null.</param>
/// <param name="receivingStream">The stream used to receive messages. May be null.</param>
/// <param name="target">An optional target object to invoke when incoming RPC requests arrive.</param>
/// <returns>The initialized and listening <see cref="JsonRpc"/> object.</returns>
public static JsonRpc Attach(Stream? sendingStream, Stream? receivingStream, object? target = null)
{
if (sendingStream is null && receivingStream is null)
{
throw new ArgumentException(Resources.BothReadableWritableAreNull);
}
var rpc = new JsonRpc(sendingStream, receivingStream, target);
try
{
if (receivingStream is not null)
{
rpc.StartListening();
}
return rpc;
}
catch
{
rpc.Dispose();
throw;
}
}
/// <summary>
/// Creates a JSON-RPC client proxy that conforms to the specified server interface.
/// </summary>
/// <typeparam name="T">The interface that describes the functions available on the remote end.</typeparam>
/// <param name="stream">The bidirectional stream used to send and receive JSON-RPC messages.</param>
/// <returns>
/// An instance of the generated proxy.
/// In addition to implementing <typeparamref name="T"/>, it also implements <see cref="IDisposable"/>
/// and should be disposed of to close the connection.
/// </returns>
public static T Attach<T>(Stream stream)
where T : class
{
return Attach<T>(stream, stream);
}
/// <summary>
/// Creates a JSON-RPC client proxy that conforms to the specified server interface.
/// </summary>
/// <typeparam name="T">The interface that describes the functions available on the remote end.</typeparam>
/// <param name="sendingStream">The stream used to transmit messages. May be null.</param>
/// <param name="receivingStream">The stream used to receive messages. May be null.</param>
/// <returns>
/// An instance of the generated proxy.
/// In addition to implementing <typeparamref name="T"/>, it also implements <see cref="IDisposable"/>
/// and should be disposed of to close the connection.
/// </returns>
public static T Attach<T>(Stream? sendingStream, Stream? receivingStream)
where T : class
{
TypeInfo proxyType = ProxyGeneration.Get(typeof(T).GetTypeInfo());
var rpc = new JsonRpc(sendingStream, receivingStream);
T proxy = (T)Activator.CreateInstance(proxyType.AsType(), rpc, JsonRpcProxyOptions.Default, /* onDispose: */ null)!;
rpc.StartListening();
return proxy;
}
/// <summary>
/// Creates a JSON-RPC client proxy that conforms to the specified server interface.
/// </summary>
/// <typeparam name="T">The interface that describes the functions available on the remote end.</typeparam>
/// <param name="handler">The message handler to use.</param>
/// <returns>
/// An instance of the generated proxy.
/// In addition to implementing <typeparamref name="T"/>, it also implements <see cref="IDisposable"/>
/// and should be disposed of to close the connection.
/// </returns>
public static T Attach<T>(IJsonRpcMessageHandler handler)
where T : class
{
return Attach<T>(handler, options: null);
}
/// <summary>
/// Creates a JSON-RPC client proxy that conforms to the specified server interface.
/// </summary>
/// <typeparam name="T">The interface that describes the functions available on the remote end.</typeparam>
/// <param name="handler">The message handler to use.</param>
/// <param name="options">A set of customizations for how the client proxy is wired up. If <c>null</c>, default options will be used.</param>
/// <returns>
/// An instance of the generated proxy.
/// In addition to implementing <typeparamref name="T"/>, it also implements <see cref="IDisposable"/>
/// and should be disposed of to close the connection.
/// </returns>
public static T Attach<T>(IJsonRpcMessageHandler handler, JsonRpcProxyOptions? options)
where T : class
{
TypeInfo proxyType = ProxyGeneration.Get(typeof(T).GetTypeInfo());
var rpc = new JsonRpc(handler);
T proxy = (T)Activator.CreateInstance(proxyType.AsType(), rpc, options ?? JsonRpcProxyOptions.Default, options?.OnDispose)!;
rpc.StartListening();
return proxy;
}
/// <summary>
/// Creates a JSON-RPC client proxy that conforms to the specified server interface.
/// </summary>
/// <typeparam name="T">The interface that describes the functions available on the remote end.</typeparam>
/// <returns>An instance of the generated proxy.</returns>
public T Attach<T>()
where T : class
{
return this.Attach<T>(null);
}
/// <summary>
/// Creates a JSON-RPC client proxy that conforms to the specified server interface.
/// </summary>
/// <typeparam name="T">The interface that describes the functions available on the remote end.</typeparam>
/// <param name="options">A set of customizations for how the client proxy is wired up. If <c>null</c>, default options will be used.</param>
/// <returns>An instance of the generated proxy.</returns>
public T Attach<T>(JsonRpcProxyOptions? options)
where T : class
{
TypeInfo proxyType = ProxyGeneration.Get(typeof(T).GetTypeInfo());
T proxy = (T)Activator.CreateInstance(proxyType.AsType(), this, options ?? JsonRpcProxyOptions.Default, options?.OnDispose)!;
return proxy;
}
/// <summary>
/// Creates a JSON-RPC client proxy that conforms to the specified server interface.
/// </summary>
/// <param name="interfaceType">The interface that describes the functions available on the remote end.</param>
/// <returns>An instance of the generated proxy.</returns>
public object Attach(Type interfaceType) => this.Attach(interfaceType, options: null);
/// <summary>
/// Creates a JSON-RPC client proxy that conforms to the specified server interface.
/// </summary>
/// <param name="interfaceType">The interface that describes the functions available on the remote end.</param>
/// <param name="options">A set of customizations for how the client proxy is wired up. If <c>null</c>, default options will be used.</param>
/// <returns>An instance of the generated proxy.</returns>
public object Attach(Type interfaceType, JsonRpcProxyOptions? options)
{
Requires.NotNull(interfaceType, nameof(interfaceType));
TypeInfo proxyType = ProxyGeneration.Get(interfaceType.GetTypeInfo());
object proxy = Activator.CreateInstance(proxyType.AsType(), this, options ?? JsonRpcProxyOptions.Default, options?.OnDispose)!;
return proxy;
}
/// <inheritdoc cref="AddLocalRpcTarget(object, JsonRpcTargetOptions?)"/>
public void AddLocalRpcTarget(object target) => this.AddLocalRpcTarget(target, null);
/// <inheritdoc cref="AddLocalRpcTarget(Type, object, JsonRpcTargetOptions?)"/>
public void AddLocalRpcTarget(object target, JsonRpcTargetOptions? options) => this.AddLocalRpcTarget(Requires.NotNull(target, nameof(target)).GetType(), target, options);
/// <inheritdoc cref="AddLocalRpcTarget(Type, object, JsonRpcTargetOptions?)"/>
/// <typeparam name="T"><inheritdoc cref="AddLocalRpcTarget(Type, object, JsonRpcTargetOptions?)" path="/param[@name='exposingMembersOn']"/></typeparam>
public void AddLocalRpcTarget<T>(T target, JsonRpcTargetOptions? options)
where T : notnull => this.AddLocalRpcTarget(typeof(T), target, options);
/// <inheritdoc cref="RpcTargetInfo.AddLocalRpcTarget(Type, object, JsonRpcTargetOptions?, bool)"/>
/// <exception cref="InvalidOperationException">Thrown if called after <see cref="StartListening"/> is called and <see cref="AllowModificationWhileListening"/> is <c>false</c>.</exception>
public void AddLocalRpcTarget(Type exposingMembersOn, object target, JsonRpcTargetOptions? options)
{
Requires.NotNull(exposingMembersOn, nameof(exposingMembersOn));
Requires.NotNull(target, nameof(target));
this.ThrowIfConfigurationLocked();
#pragma warning disable CA2000 // Dispose objects before losing scope
this.AddLocalRpcTargetInternal(exposingMembersOn, target, options, requestRevertOption: false);
#pragma warning restore CA2000 // Dispose objects before losing scope
}
/// <summary>
/// Adds a remote rpc connection so calls can be forwarded to the remote target if local targets do not handle it.
/// </summary>
/// <param name="remoteTarget">The json rpc connection to the remote target.</param>
public void AddRemoteRpcTarget(JsonRpc remoteTarget)
{
Requires.NotNull(remoteTarget, nameof(remoteTarget));
this.ThrowIfConfigurationLocked();
lock (this.syncObject)
{
this.remoteRpcTargets = this.remoteRpcTargets.Add(remoteTarget);
}
}
/// <summary>
/// Adds a handler for an RPC method with a given name.
/// </summary>
/// <param name="rpcMethodName">
/// The name of the method as it is identified by the incoming JSON-RPC message.
/// It need not match the name of the CLR method/delegate given here.
/// </param>
/// <param name="handler">
/// The method or delegate to invoke when a matching RPC message arrives.
/// This method may accept parameters from the incoming JSON-RPC message.
/// </param>
/// <exception cref="InvalidOperationException">Thrown if called after <see cref="StartListening"/> is called and <see cref="AllowModificationWhileListening"/> is <c>false</c>.</exception>
public void AddLocalRpcMethod(string? rpcMethodName, Delegate handler)
{
Requires.NotNull(handler, nameof(handler));
this.AddLocalRpcMethod(rpcMethodName, handler.GetMethodInfo()!, handler.Target);
}
/// <summary>
/// Adds a handler for an RPC method with a given name.
/// </summary>
/// <param name="rpcMethodName">
/// The name of the method as it is identified by the incoming JSON-RPC message.
/// It need not match the name of the CLR method/delegate given here.
/// </param>
/// <param name="handler">
/// The method or delegate to invoke when a matching RPC message arrives.
/// This method may accept parameters from the incoming JSON-RPC message.
/// </param>
/// <param name="target">An instance of the type that defines <paramref name="handler"/> which should handle the invocation.</param>
/// <exception cref="InvalidOperationException">Thrown if called after <see cref="StartListening"/> is called and <see cref="AllowModificationWhileListening"/> is <c>false</c>.</exception>
public void AddLocalRpcMethod(string? rpcMethodName, MethodInfo handler, object? target) => this.AddLocalRpcMethod(handler, target, new JsonRpcMethodAttribute(rpcMethodName));
/// <inheritdoc cref="AddLocalRpcMethod(MethodInfo, object?, JsonRpcMethodAttribute?, SynchronizationContext?)"/>
public void AddLocalRpcMethod(MethodInfo handler, object? target, JsonRpcMethodAttribute? methodRpcSettings) => this.AddLocalRpcMethod(handler, target, methodRpcSettings, synchronizationContext: null);
/// <inheritdoc cref="RpcTargetInfo.GetJsonRpcMethodAttribute(string, ReadOnlySpan{ParameterInfo})"/>
public JsonRpcMethodAttribute? GetJsonRpcMethodAttribute(string methodName, ReadOnlySpan<ParameterInfo> parameters)
{
Requires.NotNull(methodName, nameof(methodName));
return this.rpcTargetInfo.GetJsonRpcMethodAttribute(methodName, parameters);
}
/// <summary>
/// Starts listening to incoming messages.
/// </summary>
public void StartListening()
{
Verify.Operation(this.MessageHandler.CanRead, Resources.StreamMustBeReadable);
Verify.Operation(this.readLinesTask is null, Resources.InvalidAfterListenHasStarted);
Verify.NotDisposed(this);
// We take a lock around this Task.Run and field assignment,
// and also immediately within the invoked Task itself,
// to guarantee that the assignment will complete BEFORE we actually read the first message.
// See the StartListening_ShouldNotAllowIncomingMessageToRaceWithInvokeAsync test.
lock (this.syncObject)
{
this.readLinesTask = Task.Run(this.ReadAndHandleRequestsAsync, this.DisconnectedToken);
}
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="argument"><inheritdoc cref="InvokeAsync{TResult}(string, object?)" path="/param[@name='argument']"/></param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>
public Task InvokeAsync(string targetName, object? argument)
{
return this.InvokeAsync<object>(targetName, argument);
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="arguments"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='arguments']"/></param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>
public Task InvokeAsync(string targetName, params object?[]? arguments)
{
return this.InvokeAsync<object>(targetName, arguments);
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <typeparam name="TResult">Type of the method result.</typeparam>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="argument">A single method argument, must be serializable using the selected <see cref="IJsonRpcMessageFormatter"/>.</param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>
public Task<TResult> InvokeAsync<TResult>(string targetName, object? argument)
{
var arguments = new object?[] { argument };
return this.InvokeWithCancellationAsync<TResult>(targetName, arguments, CancellationToken.None);
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <typeparam name="TResult">Type of the method result.</typeparam>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="arguments"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='arguments']"/></param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>
public Task<TResult> InvokeAsync<TResult>(string targetName, params object?[]? arguments)
{
// If somebody calls InvokeInternal<T>(id, "method", null), the null is not passed as an item in the array.
// Instead, the compiler thinks that the null is the array itself and it'll pass null directly.
// To account for this case, we check for null below.
arguments = arguments ?? new object?[] { null };
return this.InvokeWithCancellationAsync<TResult>(targetName, arguments, CancellationToken.None);
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="argument"><inheritdoc cref="InvokeWithParameterObjectAsync{TResult}(string, object?, IReadOnlyDictionary{string, Type}?, CancellationToken)" path="/param[@name='argument']"/></param>
/// <param name="cancellationToken"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='cancellationToken']"/></param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>
#pragma warning disable RS0027 // Public API with optional parameter(s) should have the most parameters amongst its public overloads.
public Task InvokeWithParameterObjectAsync(string targetName, object? argument = null, CancellationToken cancellationToken = default(CancellationToken))
#pragma warning restore RS0027 // Public API with optional parameter(s) should have the most parameters amongst its public overloads.
{
return this.InvokeWithParameterObjectAsync<object>(targetName, argument, cancellationToken);
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="argument"><inheritdoc cref="InvokeWithParameterObjectAsync{TResult}(string, object?, IReadOnlyDictionary{string, Type}?, CancellationToken)" path="/param[@name='argument']"/></param>
/// <param name="argumentDeclaredTypes"><inheritdoc cref="InvokeWithParameterObjectAsync{TResult}(string, object?, IReadOnlyDictionary{string, Type}?, CancellationToken)" path="/param[@name='argumentDeclaredTypes']"/></param>
/// <param name="cancellationToken"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='cancellationToken']"/></param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>
public Task InvokeWithParameterObjectAsync(string targetName, object? argument, IReadOnlyDictionary<string, Type>? argumentDeclaredTypes, CancellationToken cancellationToken)
{
return this.InvokeWithParameterObjectAsync<object>(targetName, argument, argumentDeclaredTypes, cancellationToken);
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <typeparam name="TResult">Type of the method result.</typeparam>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="argument"><inheritdoc cref="InvokeWithParameterObjectAsync{TResult}(string, object?, IReadOnlyDictionary{string, Type}?, CancellationToken)" path="/param[@name='argument']"/></param>
/// <param name="cancellationToken"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='cancellationToken']"/></param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>
#pragma warning disable RS0027 // Public API with optional parameter(s) should have the most parameters amongst its public overloads.
public Task<TResult> InvokeWithParameterObjectAsync<TResult>(string targetName, object? argument = null, CancellationToken cancellationToken = default(CancellationToken))
#pragma warning restore RS0027 // Public API with optional parameter(s) should have the most parameters amongst its public overloads.
{
return this.InvokeWithParameterObjectAsync<TResult>(targetName, argument, null, cancellationToken);
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <typeparam name="TResult">Type of the method result.</typeparam>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="argument">An object whose properties match the names of parameters on the target method. Must be serializable using the selected <see cref="IJsonRpcMessageFormatter"/>.</param>
/// <param name="argumentDeclaredTypes">
/// A dictionary of <see cref="Type"/> objects that describe how each entry in the <see cref="IReadOnlyDictionary{TKey, TValue}"/> provided in <paramref name="argument"/> is expected by the server to be typed.
/// If specified, this must have exactly the same set of keys as <paramref name="argument"/> and contain no <c>null</c> values.
/// </param>
/// <param name="cancellationToken"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='cancellationToken']"/></param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>
public Task<TResult> InvokeWithParameterObjectAsync<TResult>(string targetName, object? argument, IReadOnlyDictionary<string, Type>? argumentDeclaredTypes, CancellationToken cancellationToken)
{
// If argument is null, this indicates that the method does not take any parameters.
object?[]? argumentToPass = argument is null ? null : new object?[] { argument };
return this.InvokeCoreAsync<TResult>(this.CreateNewRequestId(), targetName, argumentToPass, positionalArgumentDeclaredTypes: null, argumentDeclaredTypes, cancellationToken, isParameterObject: true);
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="arguments"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='arguments']"/></param>
/// <param name="cancellationToken"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='cancellationToken']"/></param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>
#pragma warning disable RS0027 // Public API with optional parameter(s) should have the most parameters amongst its public overloads.
public Task InvokeWithCancellationAsync(string targetName, IReadOnlyList<object?>? arguments = null, CancellationToken cancellationToken = default(CancellationToken))
#pragma warning restore RS0027 // Public API with optional parameter(s) should have the most parameters amongst its public overloads.
{
return this.InvokeWithCancellationAsync<object>(targetName, arguments, cancellationToken);
}
/// <summary><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/summary"/></summary>
/// <param name="targetName"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='targetName']"/></param>
/// <param name="arguments"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='arguments']"/></param>
/// <param name="argumentDeclaredTypes"><inheritdoc cref="InvokeWithCancellationAsync{TResult}(string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, CancellationToken)" path="/param[@name='argumentDeclaredTypes']"/></param>
/// <param name="cancellationToken"><inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/param[@name='cancellationToken']"/></param>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/returns"/>
/// <inheritdoc cref="InvokeCoreAsync{TResult}(RequestId, string, IReadOnlyList{object?}?, IReadOnlyList{Type}?, IReadOnlyDictionary{string, Type}?, CancellationToken, bool)" path="/exception"/>