-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathGrpc.Core.Api.xml
2606 lines (2605 loc) · 138 KB
/
Grpc.Core.Api.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>Grpc.Core.Api</name>
</assembly>
<members>
<member name="T:Grpc.Core.AsyncAuthInterceptor">
<summary>
Asynchronous authentication interceptor for <see cref="T:Grpc.Core.CallCredentials"/>.
</summary>
<param name="context">The interceptor context.</param>
<param name="metadata">Metadata to populate with entries that will be added to outgoing call's headers.</param>
<returns></returns>
</member>
<member name="T:Grpc.Core.AuthInterceptorContext">
<summary>
Context for an RPC being intercepted by <see cref="T:Grpc.Core.AsyncAuthInterceptor"/>.
</summary>
</member>
<member name="M:Grpc.Core.AuthInterceptorContext.#ctor(System.String,System.String)">
<summary>
Initializes a new instance of <c>AuthInterceptorContext</c>.
</summary>
</member>
<member name="P:Grpc.Core.AuthInterceptorContext.ServiceUrl">
<summary>
The fully qualified service URL for the RPC being called.
</summary>
</member>
<member name="P:Grpc.Core.AuthInterceptorContext.MethodName">
<summary>
The method name of the RPC being called.
</summary>
</member>
<member name="T:Grpc.Core.AsyncCallState">
<summary>
Provides an abstraction over the callback providers
used by AsyncUnaryCall, AsyncDuplexStreamingCall, etc
</summary>
</member>
<member name="T:Grpc.Core.AsyncClientStreamingCall`2">
<summary>
Return type for client streaming calls.
</summary>
<typeparam name="TRequest">Request message type for this call.</typeparam>
<typeparam name="TResponse">Response message type for this call.</typeparam>
</member>
<member name="M:Grpc.Core.AsyncClientStreamingCall`2.#ctor(Grpc.Core.IClientStreamWriter{`0},System.Threading.Tasks.Task{`1},System.Threading.Tasks.Task{Grpc.Core.Metadata},System.Func{Grpc.Core.Status},System.Func{Grpc.Core.Metadata},System.Action)">
<summary>
Creates a new AsyncClientStreamingCall object with the specified properties.
</summary>
<param name="requestStream">Stream of request values.</param>
<param name="responseAsync">The response of the asynchronous call.</param>
<param name="responseHeadersAsync">Response headers of the asynchronous call.</param>
<param name="getStatusFunc">Delegate returning the status of the call.</param>
<param name="getTrailersFunc">Delegate returning the trailing metadata of the call.</param>
<param name="disposeAction">Delegate to invoke when Dispose is called on the call object.</param>
</member>
<member name="M:Grpc.Core.AsyncClientStreamingCall`2.#ctor(Grpc.Core.IClientStreamWriter{`0},System.Threading.Tasks.Task{`1},System.Func{System.Object,System.Threading.Tasks.Task{Grpc.Core.Metadata}},System.Func{System.Object,Grpc.Core.Status},System.Func{System.Object,Grpc.Core.Metadata},System.Action{System.Object},System.Object)">
<summary>
Creates a new AsyncClientStreamingCall object with the specified properties.
</summary>
<param name="requestStream">Stream of request values.</param>
<param name="responseAsync">The response of the asynchronous call.</param>
<param name="responseHeadersAsync">Response headers of the asynchronous call.</param>
<param name="getStatusFunc">Delegate returning the status of the call.</param>
<param name="getTrailersFunc">Delegate returning the trailing metadata of the call.</param>
<param name="disposeAction">Delegate to invoke when Dispose is called on the call object.</param>
<param name="state">State object for use with the callback parameters.</param>
</member>
<member name="P:Grpc.Core.AsyncClientStreamingCall`2.ResponseAsync">
<summary>
Asynchronous call result.
</summary>
</member>
<member name="P:Grpc.Core.AsyncClientStreamingCall`2.ResponseHeadersAsync">
<summary>
Asynchronous access to response headers.
</summary>
</member>
<member name="P:Grpc.Core.AsyncClientStreamingCall`2.RequestStream">
<summary>
Async stream to send streaming requests.
</summary>
</member>
<member name="M:Grpc.Core.AsyncClientStreamingCall`2.GetAwaiter">
<summary>
Allows awaiting this object directly.
</summary>
<returns></returns>
</member>
<member name="M:Grpc.Core.AsyncClientStreamingCall`2.GetStatus">
<summary>
Gets the call status if the call has already finished.
Throws InvalidOperationException otherwise.
</summary>
</member>
<member name="M:Grpc.Core.AsyncClientStreamingCall`2.GetTrailers">
<summary>
Gets the call trailing metadata if the call has already finished.
Throws InvalidOperationException otherwise.
</summary>
</member>
<member name="M:Grpc.Core.AsyncClientStreamingCall`2.Dispose">
<summary>
Provides means to cleanup after the call.
If the call has already finished normally (request stream has been completed and call result has been received), doesn't do anything.
Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
As a result, all resources being used by the call should be released eventually.
</summary>
<remarks>
Normally, there is no need for you to dispose the call unless you want to utilize the
"Cancel" semantics of invoking <c>Dispose</c>.
</remarks>
</member>
<member name="T:Grpc.Core.AsyncDuplexStreamingCall`2">
<summary>
Return type for bidirectional streaming calls.
</summary>
<typeparam name="TRequest">Request message type for this call.</typeparam>
<typeparam name="TResponse">Response message type for this call.</typeparam>
</member>
<member name="M:Grpc.Core.AsyncDuplexStreamingCall`2.#ctor(Grpc.Core.IClientStreamWriter{`0},Grpc.Core.IAsyncStreamReader{`1},System.Threading.Tasks.Task{Grpc.Core.Metadata},System.Func{Grpc.Core.Status},System.Func{Grpc.Core.Metadata},System.Action)">
<summary>
Creates a new AsyncDuplexStreamingCall object with the specified properties.
</summary>
<param name="requestStream">Stream of request values.</param>
<param name="responseStream">Stream of response values.</param>
<param name="responseHeadersAsync">Response headers of the asynchronous call.</param>
<param name="getStatusFunc">Delegate returning the status of the call.</param>
<param name="getTrailersFunc">Delegate returning the trailing metadata of the call.</param>
<param name="disposeAction">Delegate to invoke when Dispose is called on the call object.</param>
</member>
<member name="M:Grpc.Core.AsyncDuplexStreamingCall`2.#ctor(Grpc.Core.IClientStreamWriter{`0},Grpc.Core.IAsyncStreamReader{`1},System.Func{System.Object,System.Threading.Tasks.Task{Grpc.Core.Metadata}},System.Func{System.Object,Grpc.Core.Status},System.Func{System.Object,Grpc.Core.Metadata},System.Action{System.Object},System.Object)">
<summary>
Creates a new AsyncDuplexStreamingCall object with the specified properties.
</summary>
<param name="requestStream">Stream of request values.</param>
<param name="responseStream">Stream of response values.</param>
<param name="responseHeadersAsync">Response headers of the asynchronous call.</param>
<param name="getStatusFunc">Delegate returning the status of the call.</param>
<param name="getTrailersFunc">Delegate returning the trailing metadata of the call.</param>
<param name="disposeAction">Delegate to invoke when Dispose is called on the call object.</param>
<param name="state">State object for use with the callback parameters.</param>
</member>
<member name="P:Grpc.Core.AsyncDuplexStreamingCall`2.ResponseStream">
<summary>
Async stream to read streaming responses.
</summary>
</member>
<member name="P:Grpc.Core.AsyncDuplexStreamingCall`2.RequestStream">
<summary>
Async stream to send streaming requests.
</summary>
</member>
<member name="P:Grpc.Core.AsyncDuplexStreamingCall`2.ResponseHeadersAsync">
<summary>
Asynchronous access to response headers.
</summary>
</member>
<member name="M:Grpc.Core.AsyncDuplexStreamingCall`2.GetStatus">
<summary>
Gets the call status if the call has already finished.
Throws InvalidOperationException otherwise.
</summary>
</member>
<member name="M:Grpc.Core.AsyncDuplexStreamingCall`2.GetTrailers">
<summary>
Gets the call trailing metadata if the call has already finished.
Throws InvalidOperationException otherwise.
</summary>
</member>
<member name="M:Grpc.Core.AsyncDuplexStreamingCall`2.Dispose">
<summary>
Provides means to cleanup after the call.
If the call has already finished normally (request stream has been completed and response stream has been fully read), doesn't do anything.
Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
As a result, all resources being used by the call should be released eventually.
</summary>
<remarks>
Normally, there is no need for you to dispose the call unless you want to utilize the
"Cancel" semantics of invoking <c>Dispose</c>.
</remarks>
</member>
<member name="T:Grpc.Core.AsyncServerStreamingCall`1">
<summary>
Return type for server streaming calls.
</summary>
<typeparam name="TResponse">Response message type for this call.</typeparam>
</member>
<member name="M:Grpc.Core.AsyncServerStreamingCall`1.#ctor(Grpc.Core.IAsyncStreamReader{`0},System.Threading.Tasks.Task{Grpc.Core.Metadata},System.Func{Grpc.Core.Status},System.Func{Grpc.Core.Metadata},System.Action)">
<summary>
Creates a new AsyncDuplexStreamingCall object with the specified properties.
</summary>
<param name="responseStream">Stream of response values.</param>
<param name="responseHeadersAsync">Response headers of the asynchronous call.</param>
<param name="getStatusFunc">Delegate returning the status of the call.</param>
<param name="getTrailersFunc">Delegate returning the trailing metadata of the call.</param>
<param name="disposeAction">Delegate to invoke when Dispose is called on the call object.</param>
</member>
<member name="M:Grpc.Core.AsyncServerStreamingCall`1.#ctor(Grpc.Core.IAsyncStreamReader{`0},System.Func{System.Object,System.Threading.Tasks.Task{Grpc.Core.Metadata}},System.Func{System.Object,Grpc.Core.Status},System.Func{System.Object,Grpc.Core.Metadata},System.Action{System.Object},System.Object)">
<summary>
Creates a new AsyncDuplexStreamingCall object with the specified properties.
</summary>
<param name="responseStream">Stream of response values.</param>
<param name="responseHeadersAsync">Response headers of the asynchronous call.</param>
<param name="getStatusFunc">Delegate returning the status of the call.</param>
<param name="getTrailersFunc">Delegate returning the trailing metadata of the call.</param>
<param name="disposeAction">Delegate to invoke when Dispose is called on the call object.</param>
<param name="state">State object for use with the callback parameters.</param>
</member>
<member name="P:Grpc.Core.AsyncServerStreamingCall`1.ResponseStream">
<summary>
Async stream to read streaming responses.
</summary>
</member>
<member name="P:Grpc.Core.AsyncServerStreamingCall`1.ResponseHeadersAsync">
<summary>
Asynchronous access to response headers.
</summary>
</member>
<member name="M:Grpc.Core.AsyncServerStreamingCall`1.GetStatus">
<summary>
Gets the call status if the call has already finished.
Throws InvalidOperationException otherwise.
</summary>
</member>
<member name="M:Grpc.Core.AsyncServerStreamingCall`1.GetTrailers">
<summary>
Gets the call trailing metadata if the call has already finished.
Throws InvalidOperationException otherwise.
</summary>
</member>
<member name="M:Grpc.Core.AsyncServerStreamingCall`1.Dispose">
<summary>
Provides means to cleanup after the call.
If the call has already finished normally (response stream has been fully read), doesn't do anything.
Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
As a result, all resources being used by the call should be released eventually.
</summary>
<remarks>
Normally, there is no need for you to dispose the call unless you want to utilize the
"Cancel" semantics of invoking <c>Dispose</c>.
</remarks>
</member>
<member name="T:Grpc.Core.AsyncStreamReaderExtensions">
<summary>
Extension methods for <see cref="T:Grpc.Core.IAsyncStreamReader`1"/>.
</summary>
</member>
<member name="M:Grpc.Core.AsyncStreamReaderExtensions.MoveNext``1(Grpc.Core.IAsyncStreamReader{``0})">
<summary>
Advances the stream reader to the next element in the sequence, returning the result asynchronously.
</summary>
<typeparam name="T">The message type.</typeparam>
<param name="streamReader">The stream reader.</param>
<returns>
Task containing the result of the operation: true if the reader was successfully advanced
to the next element; false if the reader has passed the end of the sequence.
</returns>
</member>
<member name="T:Grpc.Core.AsyncUnaryCall`1">
<summary>
Return type for single request - single response call.
</summary>
<typeparam name="TResponse">Response message type for this call.</typeparam>
</member>
<member name="M:Grpc.Core.AsyncUnaryCall`1.#ctor(System.Threading.Tasks.Task{`0},System.Threading.Tasks.Task{Grpc.Core.Metadata},System.Func{Grpc.Core.Status},System.Func{Grpc.Core.Metadata},System.Action)">
<summary>
Creates a new AsyncUnaryCall object with the specified properties.
</summary>
<param name="responseAsync">The response of the asynchronous call.</param>
<param name="responseHeadersAsync">Response headers of the asynchronous call.</param>
<param name="getStatusFunc">Delegate returning the status of the call.</param>
<param name="getTrailersFunc">Delegate returning the trailing metadata of the call.</param>
<param name="disposeAction">Delegate to invoke when Dispose is called on the call object.</param>
</member>
<member name="M:Grpc.Core.AsyncUnaryCall`1.#ctor(System.Threading.Tasks.Task{`0},System.Func{System.Object,System.Threading.Tasks.Task{Grpc.Core.Metadata}},System.Func{System.Object,Grpc.Core.Status},System.Func{System.Object,Grpc.Core.Metadata},System.Action{System.Object},System.Object)">
<summary>
Creates a new AsyncUnaryCall object with the specified properties.
</summary>
<param name="responseAsync">The response of the asynchronous call.</param>
<param name="responseHeadersAsync">Response headers of the asynchronous call.</param>
<param name="getStatusFunc">Delegate returning the status of the call.</param>
<param name="getTrailersFunc">Delegate returning the trailing metadata of the call.</param>
<param name="disposeAction">Delegate to invoke when Dispose is called on the call object.</param>
<param name="state">State object for use with the callback parameters.</param>
</member>
<member name="P:Grpc.Core.AsyncUnaryCall`1.ResponseAsync">
<summary>
Asynchronous call result.
</summary>
</member>
<member name="P:Grpc.Core.AsyncUnaryCall`1.ResponseHeadersAsync">
<summary>
Asynchronous access to response headers.
</summary>
</member>
<member name="M:Grpc.Core.AsyncUnaryCall`1.GetAwaiter">
<summary>
Allows awaiting this object directly.
</summary>
</member>
<member name="M:Grpc.Core.AsyncUnaryCall`1.GetStatus">
<summary>
Gets the call status if the call has already finished.
Throws InvalidOperationException otherwise.
</summary>
</member>
<member name="M:Grpc.Core.AsyncUnaryCall`1.GetTrailers">
<summary>
Gets the call trailing metadata if the call has already finished.
Throws InvalidOperationException otherwise.
</summary>
</member>
<member name="M:Grpc.Core.AsyncUnaryCall`1.Dispose">
<summary>
Provides means to cleanup after the call.
If the call has already finished normally (request stream has been completed and call result has been received), doesn't do anything.
Otherwise, requests cancellation of the call which should terminate all pending async operations associated with the call.
As a result, all resources being used by the call should be released eventually.
</summary>
<remarks>
Normally, there is no need for you to dispose the call unless you want to utilize the
"Cancel" semantics of invoking <c>Dispose</c>.
</remarks>
</member>
<member name="T:Grpc.Core.AuthContext">
<summary>
Authentication context for a call.
AuthContext is the only reliable source of truth when it comes to authenticating calls.
Using any other call/context properties for authentication purposes is wrong and inherently unsafe.
Note: experimental API that can change or be removed without any prior notice.
</summary>
</member>
<member name="M:Grpc.Core.AuthContext.#ctor(System.String,System.Collections.Generic.Dictionary{System.String,System.Collections.Generic.List{Grpc.Core.AuthProperty}})">
<summary>
Initializes a new instance of the <see cref="T:Grpc.Core.AuthContext"/> class.
</summary>
<param name="peerIdentityPropertyName">Peer identity property name.</param>
<param name="properties">Multimap of auth properties by name.</param>
</member>
<member name="P:Grpc.Core.AuthContext.IsPeerAuthenticated">
<summary>
Returns <c>true</c> if the peer is authenticated.
</summary>
</member>
<member name="P:Grpc.Core.AuthContext.PeerIdentityPropertyName">
<summary>
Gets the name of the property that indicates the peer identity. Returns <c>null</c>
if the peer is not authenticated.
</summary>
</member>
<member name="P:Grpc.Core.AuthContext.PeerIdentity">
<summary>
Gets properties that represent the peer identity (there can be more than one). Returns an empty collection
if the peer is not authenticated.
</summary>
</member>
<member name="P:Grpc.Core.AuthContext.Properties">
<summary>
Gets the auth properties of this context.
</summary>
</member>
<member name="M:Grpc.Core.AuthContext.FindPropertiesByName(System.String)">
<summary>
Returns the auth properties with given name (there can be more than one).
If no properties of given name exist, an empty collection will be returned.
</summary>
</member>
<member name="T:Grpc.Core.AuthProperty">
<summary>
A property of an <see cref="T:Grpc.Core.AuthContext"/>.
Note: experimental API that can change or be removed without any prior notice.
</summary>
</member>
<member name="P:Grpc.Core.AuthProperty.Name">
<summary>
Gets the name of the property.
</summary>
</member>
<member name="P:Grpc.Core.AuthProperty.Value">
<summary>
Gets the string value of the property.
</summary>
</member>
<member name="P:Grpc.Core.AuthProperty.ValueBytes">
<summary>
Gets the binary value of the property.
</summary>
</member>
<member name="M:Grpc.Core.AuthProperty.Create(System.String,System.Byte[])">
<summary>
Creates an instance of <c>AuthProperty</c>.
</summary>
<param name="name">the name</param>
<param name="valueBytes">the binary value of the property</param>
</member>
<member name="P:Grpc.Core.AuthProperty.ValueBytesUnsafe">
<summary>
Gets the binary value of the property (without making a defensive copy).
</summary>
</member>
<member name="M:Grpc.Core.AuthProperty.CreateUnsafe(System.String,System.Byte[])">
<summary>
Creates and instance of <c>AuthProperty</c> without making a defensive copy of <c>valueBytes</c>.
</summary>
</member>
<member name="T:Grpc.Core.BindServiceMethodAttribute">
<summary>
Specifies the location of the service bind method for a gRPC service.
The bind method is typically generated code and is used to register a service's
methods with the server on startup.
The bind method signature takes a <see cref="T:Grpc.Core.ServiceBinderBase"/> and an optional
instance of the service base class, e.g. <c>static void BindService(ServiceBinderBase, GreeterService)</c>.
</summary>
</member>
<member name="M:Grpc.Core.BindServiceMethodAttribute.#ctor(System.Type,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Grpc.Core.BindServiceMethodAttribute"/> class.
</summary>
<param name="bindType">The type the service bind method is defined on.</param>
<param name="bindMethodName">The name of the service bind method.</param>
</member>
<member name="P:Grpc.Core.BindServiceMethodAttribute.BindType">
<summary>
Gets the type the service bind method is defined on.
</summary>
</member>
<member name="P:Grpc.Core.BindServiceMethodAttribute.BindMethodName">
<summary>
Gets the name of the service bind method.
</summary>
</member>
<member name="T:Grpc.Core.CallCredentials">
<summary>
Client-side call credentials. Provide authorization with per-call granularity.
</summary>
</member>
<member name="M:Grpc.Core.CallCredentials.Compose(Grpc.Core.CallCredentials[])">
<summary>
Composes multiple <c>CallCredentials</c> objects into
a single <c>CallCredentials</c> object.
</summary>
<param name="credentials">credentials to compose</param>
<returns>The new <c>CompositeCallCredentials</c></returns>
</member>
<member name="M:Grpc.Core.CallCredentials.FromInterceptor(Grpc.Core.AsyncAuthInterceptor)">
<summary>
Creates a new instance of <c>CallCredentials</c> class from an
interceptor that can attach metadata to outgoing calls.
</summary>
<param name="interceptor">authentication interceptor</param>
</member>
<member name="M:Grpc.Core.CallCredentials.InternalPopulateConfiguration(Grpc.Core.CallCredentialsConfiguratorBase,System.Object)">
<summary>
Populates call credentials configurator with this instance's configuration.
End users never need to invoke this method as it is part of internal implementation.
</summary>
</member>
<member name="T:Grpc.Core.CallCredentialsConfiguratorBase">
<summary>
Base class for objects that can consume configuration from <c>CallCredentials</c> objects.
Note: experimental API that can change or be removed without any prior notice.
</summary>
</member>
<member name="M:Grpc.Core.CallCredentialsConfiguratorBase.SetCompositeCredentials(System.Object,System.Collections.Generic.IReadOnlyList{Grpc.Core.CallCredentials})">
<summary>
Consumes configuration for composite call credentials.
</summary>
</member>
<member name="M:Grpc.Core.CallCredentialsConfiguratorBase.SetAsyncAuthInterceptorCredentials(System.Object,Grpc.Core.AsyncAuthInterceptor)">
<summary>
Consumes configuration for call credentials created from <c>AsyncAuthInterceptor</c>
</summary>
</member>
<member name="T:Grpc.Core.Internal.CallFlags">
<summary>
Flags to enable special call behaviors (client-side only).
</summary>
</member>
<member name="F:Grpc.Core.Internal.CallFlags.IdempotentRequest">
<summary>
The call is idempotent (retrying the call doesn't change the outcome of the operation).
</summary>
</member>
<member name="F:Grpc.Core.Internal.CallFlags.WaitForReady">
<summary>
If channel is in <c>ChannelState.TransientFailure</c>, attempt waiting for the channel to recover
instead of failing the call immediately.
</summary>
</member>
<member name="F:Grpc.Core.Internal.CallFlags.CacheableRequest">
<summary>
The call is cacheable. gRPC is free to use GET verb */
</summary>
</member>
<member name="T:Grpc.Core.Internal.UnimplementedCallInvoker">
<summary>
Call invoker that throws <c>NotImplementedException</c> for all requests.
</summary>
</member>
<member name="T:Grpc.Core.CallInvoker">
<summary>
Abstraction of client-side RPC invocation.
</summary>
</member>
<member name="M:Grpc.Core.CallInvoker.BlockingUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
<summary>
Invokes a simple remote call in a blocking fashion.
</summary>
</member>
<member name="M:Grpc.Core.CallInvoker.AsyncUnaryCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
<summary>
Invokes a simple remote call asynchronously.
</summary>
</member>
<member name="M:Grpc.Core.CallInvoker.AsyncServerStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions,``0)">
<summary>
Invokes a server streaming call asynchronously.
In server streaming scenario, client sends on request and server responds with a stream of responses.
</summary>
</member>
<member name="M:Grpc.Core.CallInvoker.AsyncClientStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">
<summary>
Invokes a client streaming call asynchronously.
In client streaming scenario, client sends a stream of requests and server responds with a single response.
</summary>
</member>
<member name="M:Grpc.Core.CallInvoker.AsyncDuplexStreamingCall``2(Grpc.Core.Method{``0,``1},System.String,Grpc.Core.CallOptions)">
<summary>
Invokes a duplex streaming call asynchronously.
In duplex streaming scenario, client sends a stream of requests and server responds with a stream of responses.
The response stream is completely independent and both side can be sending messages at the same time.
</summary>
</member>
<member name="T:Grpc.Core.CallOptions">
<summary>
Options for calls made by client.
</summary>
</member>
<member name="M:Grpc.Core.CallOptions.#ctor(Grpc.Core.Metadata,System.Nullable{System.DateTime},System.Threading.CancellationToken,Grpc.Core.WriteOptions,Grpc.Core.ContextPropagationToken,Grpc.Core.CallCredentials)">
<summary>
Creates a new instance of <c>CallOptions</c> struct.
</summary>
<param name="headers">Headers to be sent with the call.</param>
<param name="deadline">Deadline for the call to finish. null means no deadline.</param>
<param name="cancellationToken">Can be used to request cancellation of the call.</param>
<param name="writeOptions">Write options that will be used for this call.</param>
<param name="propagationToken">Context propagation token obtained from <see cref="T:Grpc.Core.ServerCallContext"/>.</param>
<param name="credentials">Credentials to use for this call.</param>
</member>
<member name="P:Grpc.Core.CallOptions.Headers">
<summary>
Headers to send at the beginning of the call.
</summary>
</member>
<member name="P:Grpc.Core.CallOptions.Deadline">
<summary>
Call deadline.
</summary>
</member>
<member name="P:Grpc.Core.CallOptions.CancellationToken">
<summary>
Token that can be used for cancelling the call on the client side.
Cancelling the token will request cancellation
of the remote call. Best effort will be made to deliver the cancellation
notification to the server and interaction of the call with the server side
will be terminated. Unless the call finishes before the cancellation could
happen (there is an inherent race),
the call will finish with <c>StatusCode.Cancelled</c> status.
</summary>
</member>
<member name="P:Grpc.Core.CallOptions.WriteOptions">
<summary>
Write options that will be used for this call.
</summary>
</member>
<member name="P:Grpc.Core.CallOptions.PropagationToken">
<summary>
Token for propagating parent call context.
</summary>
</member>
<member name="P:Grpc.Core.CallOptions.Credentials">
<summary>
Credentials to use for this call.
</summary>
</member>
<member name="P:Grpc.Core.CallOptions.IsWaitForReady">
<summary>
If <c>true</c> and channel is in <c>ChannelState.TransientFailure</c>, the call will attempt waiting for the channel to recover
instead of failing immediately (which is the default "FailFast" semantics).
Note: experimental API that can change or be removed without any prior notice.
</summary>
</member>
<member name="P:Grpc.Core.CallOptions.Flags">
<summary>
Flags to use for this call.
</summary>
</member>
<member name="M:Grpc.Core.CallOptions.WithHeaders(Grpc.Core.Metadata)">
<summary>
Returns new instance of <see cref="T:Grpc.Core.CallOptions"/> with
<c>Headers</c> set to the value provided. Values of all other fields are preserved.
</summary>
<param name="headers">The headers.</param>
</member>
<member name="M:Grpc.Core.CallOptions.WithDeadline(System.DateTime)">
<summary>
Returns new instance of <see cref="T:Grpc.Core.CallOptions"/> with
<c>Deadline</c> set to the value provided. Values of all other fields are preserved.
</summary>
<param name="deadline">The deadline.</param>
</member>
<member name="M:Grpc.Core.CallOptions.WithCancellationToken(System.Threading.CancellationToken)">
<summary>
Returns new instance of <see cref="T:Grpc.Core.CallOptions"/> with
<c>CancellationToken</c> set to the value provided. Values of all other fields are preserved.
</summary>
<param name="cancellationToken">The cancellation token.</param>
</member>
<member name="M:Grpc.Core.CallOptions.WithWriteOptions(Grpc.Core.WriteOptions)">
<summary>
Returns new instance of <see cref="T:Grpc.Core.CallOptions"/> with
<c>WriteOptions</c> set to the value provided. Values of all other fields are preserved.
</summary>
<param name="writeOptions">The write options.</param>
</member>
<member name="M:Grpc.Core.CallOptions.WithPropagationToken(Grpc.Core.ContextPropagationToken)">
<summary>
Returns new instance of <see cref="T:Grpc.Core.CallOptions"/> with
<c>PropagationToken</c> set to the value provided. Values of all other fields are preserved.
</summary>
<param name="propagationToken">The context propagation token.</param>
</member>
<member name="M:Grpc.Core.CallOptions.WithCredentials(Grpc.Core.CallCredentials)">
<summary>
Returns new instance of <see cref="T:Grpc.Core.CallOptions"/> with
<c>Credentials</c> set to the value provided. Values of all other fields are preserved.
</summary>
<param name="credentials">The call credentials.</param>
</member>
<member name="M:Grpc.Core.CallOptions.WithWaitForReady(System.Boolean)">
<summary>
Returns new instance of <see cref="T:Grpc.Core.CallOptions"/> with "WaitForReady" semantics enabled/disabled.
<see cref="P:Grpc.Core.CallOptions.IsWaitForReady"/>.
Note: experimental API that can change or be removed without any prior notice.
</summary>
</member>
<member name="M:Grpc.Core.CallOptions.WithFlags(Grpc.Core.Internal.CallFlags)">
<summary>
Returns new instance of <see cref="T:Grpc.Core.CallOptions"/> with
<c>Flags</c> set to the value provided. Values of all other fields are preserved.
</summary>
<param name="flags">The call flags.</param>
</member>
<member name="T:Grpc.Core.ChannelBase">
<summary>
Base class for gRPC channel. Channels are an abstraction of long-lived connections to remote servers.
</summary>
</member>
<member name="M:Grpc.Core.ChannelBase.#ctor(System.String)">
<summary>
Initializes a new instance of <see cref="T:Grpc.Core.ChannelBase"/> class that connects to a specific host.
</summary>
<param name="target">Target of the channel.</param>
</member>
<member name="P:Grpc.Core.ChannelBase.Target">
<summary>The original target used to create the channel.</summary>
</member>
<member name="M:Grpc.Core.ChannelBase.CreateCallInvoker">
<summary>
Create a new <see cref="T:Grpc.Core.CallInvoker"/> for the channel.
</summary>
<returns>A new <see cref="T:Grpc.Core.CallInvoker"/>.</returns>
</member>
<member name="M:Grpc.Core.ChannelBase.ShutdownAsync">
<summary>
Shuts down the channel cleanly. It is strongly recommended to shutdown
the channel once you stopped using it.
</summary>
<remarks>
Guidance for implementors:
This method doesn't wait for all calls on this channel to finish (nor does
it have to explicitly cancel all outstanding calls). It is user's responsibility to make sure
all the calls on this channel have finished (successfully or with an error)
before shutting down the channel to ensure channel shutdown won't impact
the outcome of those remote calls.
</remarks>
</member>
<member name="M:Grpc.Core.ChannelBase.ShutdownAsyncCore">
<summary>Provides implementation of a non-virtual public member.</summary>
</member>
<member name="T:Grpc.Core.ChannelCredentials">
<summary>
Client-side channel credentials. Used for creation of a secure channel.
</summary>
</member>
<member name="M:Grpc.Core.ChannelCredentials.#ctor">
<summary>
Creates a new instance of channel credentials
</summary>
</member>
<member name="P:Grpc.Core.ChannelCredentials.Insecure">
<summary>
Returns instance of credentials that provides no security and
will result in creating an unsecure channel with no encryption whatsoever.
</summary>
</member>
<member name="M:Grpc.Core.ChannelCredentials.Create(Grpc.Core.ChannelCredentials,Grpc.Core.CallCredentials)">
<summary>
Creates a new instance of <c>ChannelCredentials</c> class by composing
given channel credentials with call credentials.
</summary>
<param name="channelCredentials">Channel credentials.</param>
<param name="callCredentials">Call credentials.</param>
<returns>The new composite <c>ChannelCredentials</c></returns>
</member>
<member name="M:Grpc.Core.ChannelCredentials.InternalPopulateConfiguration(Grpc.Core.ChannelCredentialsConfiguratorBase,System.Object)">
<summary>
Populates channel credentials configurator with this instance's configuration.
End users never need to invoke this method as it is part of internal implementation.
</summary>
</member>
<member name="P:Grpc.Core.ChannelCredentials.IsComposable">
<summary>
Returns <c>true</c> if this credential type allows being composed by <c>CompositeCredentials</c>.
</summary>
</member>
<member name="T:Grpc.Core.ChannelCredentials.CompositeChannelCredentials">
<summary>
Credentials that allow composing one <see cref="T:Grpc.Core.ChannelCredentials"/> object and
one or more <see cref="T:Grpc.Core.CallCredentials"/> objects into a single <see cref="T:Grpc.Core.ChannelCredentials"/>.
</summary>
</member>
<member name="M:Grpc.Core.ChannelCredentials.CompositeChannelCredentials.#ctor(Grpc.Core.ChannelCredentials,Grpc.Core.CallCredentials)">
<summary>
Initializes a new instance of <c>CompositeChannelCredentials</c> class.
The resulting credentials object will be composite of all the credentials specified as parameters.
</summary>
<param name="channelCredentials">channelCredentials to compose</param>
<param name="callCredentials">channelCredentials to compose</param>
</member>
<member name="T:Grpc.Core.ChannelCredentialsConfiguratorBase">
<summary>
Base class for objects that can consume configuration from <c>CallCredentials</c> objects.
Note: experimental API that can change or be removed without any prior notice.
</summary>
</member>
<member name="M:Grpc.Core.ChannelCredentialsConfiguratorBase.SetInsecureCredentials(System.Object)">
<summary>
Configures the credentials to use insecure credentials.
</summary>
</member>
<member name="M:Grpc.Core.ChannelCredentialsConfiguratorBase.SetSslCredentials(System.Object,System.String,Grpc.Core.KeyCertificatePair,Grpc.Core.VerifyPeerCallback)">
<summary>
Configures the credentials to use <c>SslCredentials</c>.
</summary>
</member>
<member name="M:Grpc.Core.ChannelCredentialsConfiguratorBase.SetCompositeCredentials(System.Object,Grpc.Core.ChannelCredentials,Grpc.Core.CallCredentials)">
<summary>
Configures the credentials to use composite channel credentials (a composite of channel credentials and call credentials).
</summary>
</member>
<member name="T:Grpc.Core.ClientBase`1">
<summary>
Generic base class for client-side stubs.
</summary>
</member>
<member name="M:Grpc.Core.ClientBase`1.#ctor">
<summary>
Initializes a new instance of <c>ClientBase</c> class that
throws <c>NotImplementedException</c> upon invocation of any RPC.
This constructor is only provided to allow creation of test doubles
for client classes (e.g. mocking requires a parameterless constructor).
</summary>
</member>
<member name="M:Grpc.Core.ClientBase`1.#ctor(Grpc.Core.ClientBase.ClientBaseConfiguration)">
<summary>
Initializes a new instance of <c>ClientBase</c> class.
</summary>
<param name="configuration">The configuration.</param>
</member>
<member name="M:Grpc.Core.ClientBase`1.#ctor(Grpc.Core.ChannelBase)">
<summary>
Initializes a new instance of <c>ClientBase</c> class.
</summary>
<param name="channel">The channel to use for remote call invocation.</param>
</member>
<member name="M:Grpc.Core.ClientBase`1.#ctor(Grpc.Core.CallInvoker)">
<summary>
Initializes a new instance of <c>ClientBase</c> class.
</summary>
<param name="callInvoker">The <c>CallInvoker</c> for remote call invocation.</param>
</member>
<member name="M:Grpc.Core.ClientBase`1.WithHost(System.String)">
<summary>
Creates a new client that sets host field for calls explicitly.
gRPC supports multiple "hosts" being served by a single server.
By default (if a client was not created by calling this method),
host <c>null</c> with the meaning "use default host" is used.
</summary>
</member>
<member name="M:Grpc.Core.ClientBase`1.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)">
<summary>
Creates a new instance of client from given <c>ClientBaseConfiguration</c>.
</summary>
</member>
<member name="T:Grpc.Core.ClientBase">
<summary>
Base class for client-side stubs.
</summary>
</member>
<member name="M:Grpc.Core.ClientBase.#ctor">
<summary>
Initializes a new instance of <c>ClientBase</c> class that
throws <c>NotImplementedException</c> upon invocation of any RPC.
This constructor is only provided to allow creation of test doubles
for client classes (e.g. mocking requires a parameterless constructor).
</summary>
</member>
<member name="M:Grpc.Core.ClientBase.#ctor(Grpc.Core.ClientBase.ClientBaseConfiguration)">
<summary>
Initializes a new instance of <c>ClientBase</c> class.
</summary>
<param name="configuration">The configuration.</param>
</member>
<member name="M:Grpc.Core.ClientBase.#ctor(Grpc.Core.ChannelBase)">
<summary>
Initializes a new instance of <c>ClientBase</c> class.
</summary>
<param name="channel">The channel to use for remote call invocation.</param>
</member>
<member name="M:Grpc.Core.ClientBase.#ctor(Grpc.Core.CallInvoker)">
<summary>
Initializes a new instance of <c>ClientBase</c> class.
</summary>
<param name="callInvoker">The <c>CallInvoker</c> for remote call invocation.</param>
</member>
<member name="P:Grpc.Core.ClientBase.CallInvoker">
<summary>
Gets the call invoker.
</summary>
</member>
<member name="P:Grpc.Core.ClientBase.Configuration">
<summary>
Gets the configuration.
</summary>
</member>
<member name="T:Grpc.Core.ClientBase.ClientBaseConfiguration">
<summary>
Represents configuration of ClientBase. The class itself is visible to
subclasses, but contents are marked as internal to make the instances opaque.
The verbose name of this class was chosen to make name clash in generated code
less likely.
</summary>
</member>
<member name="M:Grpc.Core.ClientBase.ClientBaseConfiguration.ClientBaseConfigurationInterceptor.#ctor(System.Func{Grpc.Core.IMethod,System.String,Grpc.Core.CallOptions,Grpc.Core.ClientBase.ClientBaseConfiguration.ClientBaseConfigurationInfo})">
<summary>
Creates a new instance of ClientBaseConfigurationInterceptor given the specified header and host interceptor function.
</summary>
</member>
<member name="T:Grpc.Core.ContextPropagationOptions">
<summary>
Options for <see cref="T:Grpc.Core.ContextPropagationToken"/>.
</summary>
</member>
<member name="F:Grpc.Core.ContextPropagationOptions.Default">
<summary>
The context propagation options that will be used by default.
</summary>
</member>
<member name="M:Grpc.Core.ContextPropagationOptions.#ctor(System.Boolean,System.Boolean)">
<summary>
Creates new context propagation options.
</summary>
<param name="propagateDeadline">If set to <c>true</c> parent call's deadline will be propagated to the child call.</param>
<param name="propagateCancellation">If set to <c>true</c> parent call's cancellation token will be propagated to the child call.</param>
</member>
<member name="P:Grpc.Core.ContextPropagationOptions.IsPropagateDeadline">
<summary><c>true</c> if parent call's deadline should be propagated to the child call.</summary>
</member>
<member name="P:Grpc.Core.ContextPropagationOptions.IsPropagateCancellation">
<summary><c>true</c> if parent call's cancellation token should be propagated to the child call.</summary>
</member>
<member name="T:Grpc.Core.ContextPropagationToken">
<summary>
Token for propagating context of server side handlers to child calls.
In situations when a backend is making calls to another backend,
it makes sense to propagate properties like deadline and cancellation
token of the server call to the child call.
Underlying gRPC implementation may provide other "opaque" contexts (like tracing context) that
are not explicitly accesible via the public C# API, but this token still allows propagating them.
</summary>
</member>
<member name="T:Grpc.Core.DeserializationContext">
<summary>
Provides access to the payload being deserialized when deserializing messages.
</summary>
</member>
<member name="P:Grpc.Core.DeserializationContext.PayloadLength">
<summary>
Get the total length of the payload in bytes.
</summary>
</member>
<member name="M:Grpc.Core.DeserializationContext.PayloadAsNewBuffer">
<summary>
Gets the entire payload as a newly allocated byte array.
Once the byte array is returned, the byte array becomes owned by the caller and won't be ever accessed or reused by gRPC again.
NOTE: Obtaining the buffer as a newly allocated byte array is the simplest way of accessing the payload,
but it can have important consequences in high-performance scenarios.
In particular, using this method usually requires copying of the entire buffer one extra time.
Also, allocating a new buffer each time can put excessive pressure on GC, especially if
the payload is more than 86700 bytes large (which means the newly allocated buffer will be placed in LOH,
and LOH object can only be garbage collected via a full ("stop the world") GC run).
NOTE: Deserializers are expected not to call this method (or other payload accessor methods) more than once per received message
(as there is no practical reason for doing so) and <c>DeserializationContext</c> implementations are free to assume so.
</summary>
<returns>byte array containing the entire payload.</returns>
</member>
<member name="M:Grpc.Core.DeserializationContext.PayloadAsReadOnlySequence">
<summary>
Gets the entire payload as a ReadOnlySequence.
The ReadOnlySequence is only valid for the duration of the deserializer routine and the caller must not access it after the deserializer returns.
Using the read only sequence is the most efficient way to access the message payload. Where possible it allows directly
accessing the received payload without needing to perform any buffer copying or buffer allocations.
NOTE: When using this method, it is recommended to use C# 7.2 compiler to make it more useful (using Span type directly from your code requires C# 7.2)."
NOTE: Deserializers are expected not to call this method (or other payload accessor methods) more than once per received message
(as there is no practical reason for doing so) and <c>DeserializationContext</c> implementations are free to assume so.
</summary>
<returns>read only sequence containing the entire payload.</returns>
</member>
<member name="T:Grpc.Core.IAsyncStreamReader`1">
<summary>
A stream of messages to be read.
Messages can be awaited <c>await reader.MoveNext()</c>, that returns <c>true</c>
if there is a message available and <c>false</c> if there are no more messages
(i.e. the stream has been closed).
<para>
On the client side, the last invocation of <c>MoveNext()</c> either returns <c>false</c>
if the call has finished successfully or throws <c>RpcException</c> if call finished
with an error. Once the call finishes, subsequent invocations of <c>MoveNext()</c> will
continue yielding the same result (returning <c>false</c> or throwing an exception).
</para>
<para>
On the server side, <c>MoveNext()</c> does not throw exceptions.
In case of a failure, the request stream will appear to be finished
(<c>MoveNext</c> will return <c>false</c>) and the <c>CancellationToken</c>
associated with the call will be cancelled to signal the failure.
</para>
<para>
<c>MoveNext()</c> operations can be cancelled via a cancellation token. Cancelling
an individual read operation has the same effect as cancelling the entire call
(which will also result in the read operation returning prematurely), but the per-read cancellation
tokens passed to MoveNext() only result in cancelling the call if the read operation haven't finished
yet.
</para>
</summary>
<typeparam name="T">The message type.</typeparam>
</member>
<member name="P:Grpc.Core.IAsyncStreamReader`1.Current">
<summary>
Gets the current element in the iteration.
</summary>
</member>
<member name="M:Grpc.Core.IAsyncStreamReader`1.MoveNext(System.Threading.CancellationToken)">
<summary>
Advances the reader to the next element in the sequence, returning the result asynchronously.
</summary>
<param name="cancellationToken">Cancellation token that can be used to cancel the operation.</param>
<returns>
Task containing the result of the operation: true if the reader was successfully advanced
to the next element; false if the reader has passed the end of the sequence.</returns>
</member>
<member name="T:Grpc.Core.IAsyncStreamWriter`1">
<summary>
A writable stream of messages.
</summary>
<typeparam name="T">The message type.</typeparam>
</member>
<member name="M:Grpc.Core.IAsyncStreamWriter`1.WriteAsync(`0)">
<summary>
Writes a message asynchronously. Only one write can be pending at a time.
</summary>
<param name="message">The message to be written. Cannot be null.</param>
</member>
<member name="P:Grpc.Core.IAsyncStreamWriter`1.WriteOptions">
<summary>
Write options that will be used for the next write.
If null, default options will be used.
Once set, this property maintains its value across subsequent
writes.
</summary>
</member>
<member name="T:Grpc.Core.IClientStreamWriter`1">
<summary>
Client-side writable stream of messages with Close capability.
</summary>
<typeparam name="T">The message type.</typeparam>