-
Notifications
You must be signed in to change notification settings - Fork 257
/
KvsActorStateProviderBase.xml
887 lines (887 loc) · 83.5 KB
/
KvsActorStateProviderBase.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
<Type Name="KvsActorStateProviderBase" FullName="Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase">
<TypeSignature Language="C#" Value="public abstract class KvsActorStateProviderBase : Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider, Microsoft.ServiceFabric.Data.IStateProviderReplica2" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit KvsActorStateProviderBase extends System.Object implements class Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider, class Microsoft.ServiceFabric.Data.IStateProviderReplica, class Microsoft.ServiceFabric.Data.IStateProviderReplica2" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class KvsActorStateProviderBase
Implements IActorStateProvider, IStateProviderReplica2" />
<TypeSignature Language="F#" Value="type KvsActorStateProviderBase = class
 interface IActorStateProvider
 interface IStateProviderReplica2
 interface IStateProviderReplica
 interface VolatileLogicalTimeManager.ISnapshotHandler" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.ServiceFabric.Data.IStateProviderReplica</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.ServiceFabric.Data.IStateProviderReplica2</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Provides an implementation of <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider" /> which
uses <see cref="T:System.Fabric.KeyValueStoreReplica" /> to store and persist the actor state.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ActorActivatedAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IActorStateProvider.ActorActivatedAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ActorActivatedAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#ActorActivatedAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function ActorActivatedAsync (actorId As ActorId, cancellationToken As CancellationToken) As Task Implements IActorStateProvider.ActorActivatedAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ActorActivatedAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ActorActivatedAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ActorActivatedAsync (actorId, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ActorActivatedAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">The ID of the actor that is activated.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
This method is invoked as part of the activation process of the actor with the specified Id.
</summary>
<returns> A task that represents the asynchronous Actor activation notification processing.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ContainsStateAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task<bool> IActorStateProvider.ContainsStateAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, string stateName, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ContainsStateAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, string stateName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#ContainsStateAsync(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function ContainsStateAsync (actorId As ActorId, stateName As String, cancellationToken As CancellationToken) As Task(Of Boolean) Implements IActorStateProvider.ContainsStateAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ContainsStateAsync : Microsoft.ServiceFabric.Actors.ActorId * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ContainsStateAsync : Microsoft.ServiceFabric.Actors.ActorId * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ContainsStateAsync (actorId, stateName, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ContainsStateAsync(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Boolean></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="stateName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor for which to check state existence.</param>
<param name="stateName">Name of the actor state to check for existence.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Checks whether the actor state provider contains an actor state with
specified state name.
</summary>
<returns>
A task that represents the asynchronous check operation. The value of TResult
parameter is <c>true</c> if state with specified name exists otherwise <c>false</c>.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteReminderAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IActorStateProvider.DeleteReminderAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, string reminderName, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteReminderAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, string reminderName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#DeleteReminderAsync(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function DeleteReminderAsync (actorId As ActorId, reminderName As String, cancellationToken As CancellationToken) As Task Implements IActorStateProvider.DeleteReminderAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteReminderAsync : Microsoft.ServiceFabric.Actors.ActorId * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteReminderAsync : Microsoft.ServiceFabric.Actors.ActorId * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteReminderAsync (actorId, reminderName, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteReminderAsync(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="reminderName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">The ID of the actor for which to delete the reminder.</param>
<param name="reminderName">The name of the reminder to delete.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Deletes the specified actor reminder if it exists.
</summary>
<returns>A task that represents the asynchronous delete operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteRemindersAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IActorStateProvider.DeleteRemindersAsync (System.Collections.Generic.IReadOnlyDictionary<Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection<string>> reminderNames, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteRemindersAsync(class System.Collections.Generic.IReadOnlyDictionary`2<class Microsoft.ServiceFabric.Actors.ActorId, class System.Collections.Generic.IReadOnlyCollection`1<string>> reminderNames, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#DeleteRemindersAsync(System.Collections.Generic.IReadOnlyDictionary{Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection{System.String}},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function DeleteRemindersAsync (reminderNames As IReadOnlyDictionary(Of ActorId, IReadOnlyCollection(Of String)), cancellationToken As CancellationToken) As Task Implements IActorStateProvider.DeleteRemindersAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteRemindersAsync : System.Collections.Generic.IReadOnlyDictionary<Microsoft.ServiceFabric.Actors.ActorId, System.Collections.Generic.IReadOnlyCollection<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteRemindersAsync : System.Collections.Generic.IReadOnlyDictionary<Microsoft.ServiceFabric.Actors.ActorId, System.Collections.Generic.IReadOnlyCollection<string>> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteRemindersAsync (reminderNames, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.DeleteRemindersAsync(System.Collections.Generic.IReadOnlyDictionary{Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection{System.String}},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reminderNames" Type="System.Collections.Generic.IReadOnlyDictionary<Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection<System.String>>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="reminderNames">The set of reminders to delete.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Deletes the specified set of reminders.
</summary>
<returns>A task that represents the asynchronous delete operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.EnumerateStateNamesAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<string>> IActorStateProvider.EnumerateStateNamesAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<string>> Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.EnumerateStateNamesAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#EnumerateStateNamesAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function EnumerateStateNamesAsync (actorId As ActorId, cancellationToken As CancellationToken) As Task(Of IEnumerable(Of String)) Implements IActorStateProvider.EnumerateStateNamesAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.EnumerateStateNamesAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<string>>
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.EnumerateStateNamesAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<string>>" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.EnumerateStateNamesAsync (actorId, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.EnumerateStateNamesAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<System.String>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">The ID of the actor for which to create enumerable.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Creates an enumerable of all the state names associated with specified actor.
</summary>
<returns>
A task that represents the asynchronous enumeration operation. The value of TResult
parameter is an enumerable of all state names associated with specified actor.
</returns>
<remarks>
The enumerator returned from actor state provider is safe to use concurrently
with reads and writes to the state provider. It represents a snapshot consistent
view of the state provider.
</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetActorsAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>> IActorStateProvider.GetActorsAsync (int numItemsToReturn, Microsoft.ServiceFabric.Actors.Query.ContinuationToken continuationToken, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceFabric.Actors.Query.PagedResult`1<class Microsoft.ServiceFabric.Actors.ActorId>> Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetActorsAsync(int32 numItemsToReturn, class Microsoft.ServiceFabric.Actors.Query.ContinuationToken continuationToken, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#GetActorsAsync(System.Int32,Microsoft.ServiceFabric.Actors.Query.ContinuationToken,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function GetActorsAsync (numItemsToReturn As Integer, continuationToken As ContinuationToken, cancellationToken As CancellationToken) As Task(Of PagedResult(Of ActorId)) Implements IActorStateProvider.GetActorsAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetActorsAsync : int * Microsoft.ServiceFabric.Actors.Query.ContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>>
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetActorsAsync : int * Microsoft.ServiceFabric.Actors.Query.ContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>>" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetActorsAsync (numItemsToReturn, continuationToken, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetActorsAsync(System.Int32,Microsoft.ServiceFabric.Actors.Query.ContinuationToken,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.PagedResult<Microsoft.ServiceFabric.Actors.ActorId>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="numItemsToReturn" Type="System.Int32" />
<Parameter Name="continuationToken" Type="Microsoft.ServiceFabric.Actors.Query.ContinuationToken" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="numItemsToReturn">The number of items requested to be returned.</param>
<param name="continuationToken">
A continuation token to start querying the results from.
A null value of continuation token means start returning values form the beginning.
</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Gets the ActorIds from the State Provider.
</summary>
<returns>A task that represents the asynchronous operation of call to server.</returns>
<remarks>
The <paramref name="continuationToken" /> is relative to the state of actor state provider
at the time of invocation of this API. If the state of actor state provider changes (i.e.
new actors are activated or existing actors are deleted) in between calls to this API and
the continuation token from previous call (before the state was modified) is supplied, the
result may contain entries that were already fetched in previous calls.
</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetRemindersAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.ReminderPagedResult<System.Collections.Generic.KeyValuePair<Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.List<Microsoft.ServiceFabric.Actors.Runtime.ActorReminderState>>>> IActorStateProvider.GetRemindersAsync (int numItemsToReturn, Microsoft.ServiceFabric.Actors.ActorId actorId, Microsoft.ServiceFabric.Actors.Query.ContinuationToken continuationToken, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceFabric.Actors.Query.ReminderPagedResult`1<valuetype System.Collections.Generic.KeyValuePair`2<class Microsoft.ServiceFabric.Actors.ActorId, class System.Collections.Generic.List`1<class Microsoft.ServiceFabric.Actors.Runtime.ActorReminderState>>>> Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetRemindersAsync(int32 numItemsToReturn, class Microsoft.ServiceFabric.Actors.ActorId actorId, class Microsoft.ServiceFabric.Actors.Query.ContinuationToken continuationToken, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#GetRemindersAsync(System.Int32,Microsoft.ServiceFabric.Actors.ActorId,Microsoft.ServiceFabric.Actors.Query.ContinuationToken,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function GetRemindersAsync (numItemsToReturn As Integer, actorId As ActorId, continuationToken As ContinuationToken, cancellationToken As CancellationToken) As Task(Of ReminderPagedResult(Of KeyValuePair(Of ActorId, List(Of ActorReminderState)))) Implements IActorStateProvider.GetRemindersAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetRemindersAsync : int * Microsoft.ServiceFabric.Actors.ActorId * Microsoft.ServiceFabric.Actors.Query.ContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.ReminderPagedResult<System.Collections.Generic.KeyValuePair<Microsoft.ServiceFabric.Actors.ActorId, System.Collections.Generic.List<Microsoft.ServiceFabric.Actors.Runtime.ActorReminderState>>>>
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetRemindersAsync : int * Microsoft.ServiceFabric.Actors.ActorId * Microsoft.ServiceFabric.Actors.Query.ContinuationToken * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.ReminderPagedResult<System.Collections.Generic.KeyValuePair<Microsoft.ServiceFabric.Actors.ActorId, System.Collections.Generic.List<Microsoft.ServiceFabric.Actors.Runtime.ActorReminderState>>>>" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetRemindersAsync (numItemsToReturn, actorId, continuationToken, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.GetRemindersAsync(System.Int32,Microsoft.ServiceFabric.Actors.ActorId,Microsoft.ServiceFabric.Actors.Query.ContinuationToken,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Query.ReminderPagedResult<System.Collections.Generic.KeyValuePair<Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.List<Microsoft.ServiceFabric.Actors.Runtime.ActorReminderState>>>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="numItemsToReturn" Type="System.Int32" />
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="continuationToken" Type="Microsoft.ServiceFabric.Actors.Query.ContinuationToken" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="numItemsToReturn">To be added.</param>
<param name="actorId">To be added.</param>
<param name="continuationToken">To be added.</param>
<param name="cancellationToken">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.Initialize">
<MemberSignature Language="C#" Value="void IActorStateProvider.Initialize (Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation actorTypeInformation);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.Initialize(class Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation actorTypeInformation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#Initialize(Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation)" />
<MemberSignature Language="VB.NET" Value="Sub Initialize (actorTypeInformation As ActorTypeInformation) Implements IActorStateProvider.Initialize" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.Initialize : Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation -> unit
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.Initialize : Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation -> unit" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.Initialize actorTypeInformation" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.Initialize(Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorTypeInformation" Type="Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation" />
</Parameters>
<Docs>
<param name="actorTypeInformation">Type information of the actor class</param>
<summary>
Initializes the actor state provider with type information
of the actor type associated with it.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadRemindersAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminderCollection> IActorStateProvider.LoadRemindersAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceFabric.Actors.Runtime.IActorReminderCollection> Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadRemindersAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#LoadRemindersAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function LoadRemindersAsync (cancellationToken As CancellationToken) As Task(Of IActorReminderCollection) Implements IActorStateProvider.LoadRemindersAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadRemindersAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminderCollection>
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadRemindersAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminderCollection>" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadRemindersAsync cancellationToken" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadRemindersAsync(System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminderCollection></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">Cancellation token for asynchronous load operation.</param>
<summary>
Loads all the reminders contained in the actor state provider.
</summary>
<returns>
A task that represents the asynchronous load operation. The value of TResult
parameter is a collection of all actor reminders contained in the actor state provider.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadStateAsync<T>">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task<T> IActorStateProvider.LoadStateAsync<T> (Microsoft.ServiceFabric.Actors.ActorId actorId, string stateName, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!!T> Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadStateAsync<T>(class Microsoft.ServiceFabric.Actors.ActorId actorId, string stateName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#LoadStateAsync``1(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function LoadStateAsync(Of T) (actorId As ActorId, stateName As String, cancellationToken As CancellationToken) As Task(Of T) Implements IActorStateProvider.LoadStateAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadStateAsync : Microsoft.ServiceFabric.Actors.ActorId * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadStateAsync : Microsoft.ServiceFabric.Actors.ActorId * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadStateAsync (actorId, stateName, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.LoadStateAsync``1(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="stateName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">The type of value of actor state associated with given state name.</typeparam>
<param name="actorId">The ID of the actor for which to load the state.</param>
<param name="stateName">The name of the actor state to load.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Loads the actor state associated with the specified state name.
</summary>
<returns>
A task that represents the asynchronous load operation. The value of TResult
parameter contains value of actor state associated with given state name.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">The actor state associated with specified state name does not exist.</exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ReminderCallbackCompletedAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IActorStateProvider.ReminderCallbackCompletedAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ReminderCallbackCompletedAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, class Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#ReminderCallbackCompletedAsync(Microsoft.ServiceFabric.Actors.ActorId,Microsoft.ServiceFabric.Actors.Runtime.IActorReminder,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function ReminderCallbackCompletedAsync (actorId As ActorId, reminder As IActorReminder, cancellationToken As CancellationToken) As Task Implements IActorStateProvider.ReminderCallbackCompletedAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ReminderCallbackCompletedAsync : Microsoft.ServiceFabric.Actors.ActorId * Microsoft.ServiceFabric.Actors.Runtime.IActorReminder * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ReminderCallbackCompletedAsync : Microsoft.ServiceFabric.Actors.ActorId * Microsoft.ServiceFabric.Actors.Runtime.IActorReminder * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ReminderCallbackCompletedAsync (actorId, reminder, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.ReminderCallbackCompletedAsync(Microsoft.ServiceFabric.Actors.ActorId,Microsoft.ServiceFabric.Actors.Runtime.IActorReminder,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="reminder" Type="Microsoft.ServiceFabric.Actors.Runtime.IActorReminder" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">The ID of the actor which own reminder</param>
<param name="reminder">The actor reminder that completed successfully.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
This method is invoked when a reminder fires and finishes executing its callback
<see cref="M:Microsoft.ServiceFabric.Actors.Runtime.IRemindable.ReceiveReminderAsync(System.String,System.Byte[],System.TimeSpan,System.TimeSpan)" /> successfully.
</summary>
<returns>
A task that represents the asynchronous reminder callback completed notification processing.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.RemoveActorAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IActorStateProvider.RemoveActorAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.RemoveActorAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#RemoveActorAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function RemoveActorAsync (actorId As ActorId, cancellationToken As CancellationToken) As Task Implements IActorStateProvider.RemoveActorAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.RemoveActorAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.RemoveActorAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.RemoveActorAsync (actorId, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.RemoveActorAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor for which to remove state.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Removes all the existing states and reminders associated with specified actor atomically.
</summary>
<returns>A task that represents the asynchronous remove operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveReminderAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IActorStateProvider.SaveReminderAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveReminderAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, class Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#SaveReminderAsync(Microsoft.ServiceFabric.Actors.ActorId,Microsoft.ServiceFabric.Actors.Runtime.IActorReminder,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function SaveReminderAsync (actorId As ActorId, reminder As IActorReminder, cancellationToken As CancellationToken) As Task Implements IActorStateProvider.SaveReminderAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveReminderAsync : Microsoft.ServiceFabric.Actors.ActorId * Microsoft.ServiceFabric.Actors.Runtime.IActorReminder * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveReminderAsync : Microsoft.ServiceFabric.Actors.ActorId * Microsoft.ServiceFabric.Actors.Runtime.IActorReminder * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveReminderAsync (actorId, reminder, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveReminderAsync(Microsoft.ServiceFabric.Actors.ActorId,Microsoft.ServiceFabric.Actors.Runtime.IActorReminder,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="reminder" Type="Microsoft.ServiceFabric.Actors.Runtime.IActorReminder" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">The ID of the actor for which to save the reminder.</param>
<param name="reminder">The actor reminder to save.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Saves the specified actor reminder. If an actor reminder with
given name does not exist, it adds the actor reminder otherwise
existing actor reminder with same name is updated.
</summary>
<returns>A task that represents the asynchronous save operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveStateAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IActorStateProvider.SaveStateAsync (Microsoft.ServiceFabric.Actors.ActorId actorId, System.Collections.Generic.IReadOnlyCollection<Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange> stateChanges, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveStateAsync(class Microsoft.ServiceFabric.Actors.ActorId actorId, class System.Collections.Generic.IReadOnlyCollection`1<class Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange> stateChanges, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Actors#Runtime#IActorStateProvider#SaveStateAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection{Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function SaveStateAsync (actorId As ActorId, stateChanges As IReadOnlyCollection(Of ActorStateChange), cancellationToken As CancellationToken) As Task Implements IActorStateProvider.SaveStateAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveStateAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Collections.Generic.IReadOnlyCollection<Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange> * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveStateAsync : Microsoft.ServiceFabric.Actors.ActorId * System.Collections.Generic.IReadOnlyCollection<Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange> * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveStateAsync (actorId, stateChanges, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider.SaveStateAsync(Microsoft.ServiceFabric.Actors.ActorId,System.Collections.Generic.IReadOnlyCollection{Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange},System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="stateChanges" Type="System.Collections.Generic.IReadOnlyCollection<Microsoft.ServiceFabric.Actors.Runtime.ActorStateChange>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="actorId">ID of the actor for which to save the state changes.</param>
<param name="stateChanges">Collection of state changes to save.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Saves the specified set of actor state changes atomically.
</summary>
<returns>A task that represents the asynchronous save operation.</returns>
<remarks>
The collection of state changes should contain only one item for a given state name.
The save operation will fail on trying to add an actor state which already exists
or update/remove an actor state which does not exist.
</remarks>
<exception cref="T:System.InvalidOperationException">
When <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.StateChangeKind" /> is <see cref="F:Microsoft.ServiceFabric.Actors.Runtime.StateChangeKind.None" /></exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Data.IStateProviderReplica.Abort">
<MemberSignature Language="C#" Value="void IStateProviderReplica.Abort ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void Microsoft.ServiceFabric.Data.IStateProviderReplica.Abort() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Data#IStateProviderReplica#Abort" />
<MemberSignature Language="VB.NET" Value="Sub Abort () Implements IStateProviderReplica.Abort" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Data.IStateProviderReplica.Abort : unit -> unit
override this.Microsoft.ServiceFabric.Data.IStateProviderReplica.Abort : unit -> unit" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Data.IStateProviderReplica.Abort " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Data.IStateProviderReplica.Abort</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Forcefully abort the state provider replica.
</summary>
<remarks>
This generally occurs when a permanent fault is detected on the node, or when
Service Fabric cannot reliably manage the replica's life-cycle due to internal failures.
</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IStateProviderReplica.BackupAsync (Func<Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task<bool>> backupCallback);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync(class System.Func`3<class Microsoft.ServiceFabric.Data.BackupInfo, valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task`1<bool>> backupCallback) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Data#IStateProviderReplica#BackupAsync(System.Func{Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})" />
<MemberSignature Language="VB.NET" Value="Function BackupAsync (backupCallback As Func(Of BackupInfo, CancellationToken, Task(Of Boolean))) As Task Implements IStateProviderReplica.BackupAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync : Func<Microsoft.ServiceFabric.Data.BackupInfo, System.Threading.CancellationToken, System.Threading.Tasks.Task<bool>> -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync : Func<Microsoft.ServiceFabric.Data.BackupInfo, System.Threading.CancellationToken, System.Threading.Tasks.Task<bool>> -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync backupCallback" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync(System.Func{Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="backupCallback" Type="System.Func<Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task<System.Boolean>>" />
</Parameters>
<Docs>
<param name="backupCallback">Callback to be called when the backup folder has been created locally and is ready to be moved out of the node.</param>
<summary>
Performs a full backup of all reliable state managed by this actor sate provider.
</summary>
<returns>Task that represents the asynchronous backup operation.</returns>
<remarks>
A FULL backup will be performed with a one-hour timeout.
Boolean returned by the backupCallback indicate whether the service was able to successfully move the backup folder to an external location.
If false is returned, BackupAsync throws InvalidOperationException with the relevant message indicating backupCallback returned false.
Also, backup will be marked as unsuccessful.
</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IStateProviderReplica.BackupAsync (Microsoft.ServiceFabric.Data.BackupOption option, TimeSpan timeout, System.Threading.CancellationToken cancellationToken, Func<Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task<bool>> backupCallback);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync(valuetype Microsoft.ServiceFabric.Data.BackupOption option, valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken, class System.Func`3<class Microsoft.ServiceFabric.Data.BackupInfo, valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task`1<bool>> backupCallback) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Data#IStateProviderReplica#BackupAsync(Microsoft.ServiceFabric.Data.BackupOption,System.TimeSpan,System.Threading.CancellationToken,System.Func{Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})" />
<MemberSignature Language="VB.NET" Value="Function BackupAsync (option As BackupOption, timeout As TimeSpan, cancellationToken As CancellationToken, backupCallback As Func(Of BackupInfo, CancellationToken, Task(Of Boolean))) As Task Implements IStateProviderReplica.BackupAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync : Microsoft.ServiceFabric.Data.BackupOption * TimeSpan * System.Threading.CancellationToken * Func<Microsoft.ServiceFabric.Data.BackupInfo, System.Threading.CancellationToken, System.Threading.Tasks.Task<bool>> -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync : Microsoft.ServiceFabric.Data.BackupOption * TimeSpan * System.Threading.CancellationToken * Func<Microsoft.ServiceFabric.Data.BackupInfo, System.Threading.CancellationToken, System.Threading.Tasks.Task<bool>> -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync (option, timeout, cancellationToken, backupCallback)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync(Microsoft.ServiceFabric.Data.BackupOption,System.TimeSpan,System.Threading.CancellationToken,System.Func{Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="option" Type="Microsoft.ServiceFabric.Data.BackupOption" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
<Parameter Name="backupCallback" Type="System.Func<Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task<System.Boolean>>" />
</Parameters>
<Docs>
<param name="option">The option for the backup.</param>
<param name="timeout">The timeout for the backup.</param>
<param name="cancellationToken">The cancellation token for the backup.</param>
<param name="backupCallback">The callback to be called once the backup folder is ready.</param>
<summary>
Performs backup of reliable state managed by this actor sate provider.
</summary>
<returns>Task that represents the asynchronous operation.</returns>
<remarks>
KvsActorStateProviderBase Backup only support Full backup. KVS BackupInfo does not contain backup version.
The Backup version is set to invalid.
</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Data.IStateProviderReplica.ChangeRoleAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IStateProviderReplica.ChangeRoleAsync (System.Fabric.ReplicaRole newRole, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Data.IStateProviderReplica.ChangeRoleAsync(valuetype System.Fabric.ReplicaRole newRole, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Data#IStateProviderReplica#ChangeRoleAsync(System.Fabric.ReplicaRole,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function ChangeRoleAsync (newRole As ReplicaRole, cancellationToken As CancellationToken) As Task Implements IStateProviderReplica.ChangeRoleAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Data.IStateProviderReplica.ChangeRoleAsync : System.Fabric.ReplicaRole * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IStateProviderReplica.ChangeRoleAsync : System.Fabric.ReplicaRole * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Data.IStateProviderReplica.ChangeRoleAsync (newRole, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Data.IStateProviderReplica.ChangeRoleAsync(System.Fabric.ReplicaRole,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="newRole" Type="System.Fabric.ReplicaRole" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="newRole">The new replica role, such as primary or secondary.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Notify the state provider replica that its role is changing, for example to Primary or Secondary.
</summary>
<returns>Task that represents the asynchronous change role operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Data.IStateProviderReplica.CloseAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IStateProviderReplica.CloseAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Data.IStateProviderReplica.CloseAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Data#IStateProviderReplica#CloseAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function CloseAsync (cancellationToken As CancellationToken) As Task Implements IStateProviderReplica.CloseAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Data.IStateProviderReplica.CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IStateProviderReplica.CloseAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Data.IStateProviderReplica.CloseAsync cancellationToken" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Data.IStateProviderReplica.CloseAsync(System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Gracefully close the state provider replica.
</summary>
<returns>Task that represents the asynchronous close operation.</returns>
<remarks>
This generally occurs when the replica's code is being upgrade, the replica is being moved
due to load balancing, or a transient fault is detected.
</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Data.IStateProviderReplica.Initialize">
<MemberSignature Language="C#" Value="void IStateProviderReplica.Initialize (System.Fabric.StatefulServiceInitializationParameters initializationParameters);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void Microsoft.ServiceFabric.Data.IStateProviderReplica.Initialize(class System.Fabric.StatefulServiceInitializationParameters initializationParameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Data#IStateProviderReplica#Initialize(System.Fabric.StatefulServiceInitializationParameters)" />
<MemberSignature Language="VB.NET" Value="Sub Initialize (initializationParameters As StatefulServiceInitializationParameters) Implements IStateProviderReplica.Initialize" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Data.IStateProviderReplica.Initialize : System.Fabric.StatefulServiceInitializationParameters -> unit
override this.Microsoft.ServiceFabric.Data.IStateProviderReplica.Initialize : System.Fabric.StatefulServiceInitializationParameters -> unit" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Data.IStateProviderReplica.Initialize initializationParameters" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Data.IStateProviderReplica.Initialize(System.Fabric.StatefulServiceInitializationParameters)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="initializationParameters" Type="System.Fabric.StatefulServiceInitializationParameters" />
</Parameters>
<Docs>
<param name="initializationParameters">
Service initialization information such as service name, partition id, replica id, and code package information.
</param>
<summary>
Initialize the state provider replica using the service initialization information.
</summary>
<remarks>
No complex processing should be done during Initialize. Expensive or long-running initialization should be done in OpenAsync.
</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Data.IStateProviderReplica.OpenAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task<System.Fabric.IReplicator> IStateProviderReplica.OpenAsync (System.Fabric.ReplicaOpenMode openMode, System.Fabric.IStatefulServicePartition partition, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Fabric.IReplicator> Microsoft.ServiceFabric.Data.IStateProviderReplica.OpenAsync(valuetype System.Fabric.ReplicaOpenMode openMode, class System.Fabric.IStatefulServicePartition partition, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Data#IStateProviderReplica#OpenAsync(System.Fabric.ReplicaOpenMode,System.Fabric.IStatefulServicePartition,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function OpenAsync (openMode As ReplicaOpenMode, partition As IStatefulServicePartition, cancellationToken As CancellationToken) As Task(Of IReplicator) Implements IStateProviderReplica.OpenAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Data.IStateProviderReplica.OpenAsync : System.Fabric.ReplicaOpenMode * System.Fabric.IStatefulServicePartition * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.IReplicator>
override this.Microsoft.ServiceFabric.Data.IStateProviderReplica.OpenAsync : System.Fabric.ReplicaOpenMode * System.Fabric.IStatefulServicePartition * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Fabric.IReplicator>" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Data.IStateProviderReplica.OpenAsync (openMode, partition, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Data.IStateProviderReplica.OpenAsync(System.Fabric.ReplicaOpenMode,System.Fabric.IStatefulServicePartition,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Fabric.IReplicator></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="openMode" Type="System.Fabric.ReplicaOpenMode" />
<Parameter Name="partition" Type="System.Fabric.IStatefulServicePartition" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="openMode">Indicates whether this is a new or existing replica.</param>
<param name="partition">The partition this replica belongs to.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Open the state provider replica for use.
</summary>
<returns>
Task that represents the asynchronous open operation. The result contains the replicator
responsible for replicating state between other state provider replicas in the partition.
</returns>
<remarks>
Extended state provider initialization tasks can be started at this time.
</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IStateProviderReplica.RestoreAsync (string backupFolderPath);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync(string backupFolderPath) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Data#IStateProviderReplica#RestoreAsync(System.String)" />
<MemberSignature Language="VB.NET" Value="Function RestoreAsync (backupFolderPath As String) As Task Implements IStateProviderReplica.RestoreAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync : string -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync : string -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync backupFolderPath" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync(System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="backupFolderPath" Type="System.String" />
</Parameters>
<Docs>
<param name="backupFolderPath">
The directory where the replica is to be restored from.
This parameter cannot be null, empty or contain just whitespace.
UNC paths may also be provided.
</param>
<summary>
Restore a backup taken by <see cref="M:Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync(System.Func{Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})" /> or
<see cref="M:Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync(Microsoft.ServiceFabric.Data.BackupOption,System.TimeSpan,System.Threading.CancellationToken,System.Func{Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})" />.
</summary>
<returns>Task that represents the asynchronous restore operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync">
<MemberSignature Language="C#" Value="System.Threading.Tasks.Task IStateProviderReplica.RestoreAsync (string backupFolderPath, Microsoft.ServiceFabric.Data.RestorePolicy restorePolicy, System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Threading.Tasks.Task Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync(string backupFolderPath, valuetype Microsoft.ServiceFabric.Data.RestorePolicy restorePolicy, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.Microsoft#ServiceFabric#Data#IStateProviderReplica#RestoreAsync(System.String,Microsoft.ServiceFabric.Data.RestorePolicy,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Function RestoreAsync (backupFolderPath As String, restorePolicy As RestorePolicy, cancellationToken As CancellationToken) As Task Implements IStateProviderReplica.RestoreAsync" />
<MemberSignature Language="F#" Value="abstract member Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync : string * Microsoft.ServiceFabric.Data.RestorePolicy * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync : string * Microsoft.ServiceFabric.Data.RestorePolicy * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="kvsActorStateProviderBase.Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync (backupFolderPath, restorePolicy, cancellationToken)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Data.IStateProviderReplica.RestoreAsync(System.String,Microsoft.ServiceFabric.Data.RestorePolicy,System.Threading.CancellationToken)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="backupFolderPath" Type="System.String" />
<Parameter Name="restorePolicy" Type="Microsoft.ServiceFabric.Data.RestorePolicy" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="backupFolderPath">
The directory where the replica is to be restored from.
This parameter cannot be null, empty or contain just whitespace.
UNC paths may also be provided.
</param>
<param name="restorePolicy">The restore policy.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Restore a backup taken by <see cref="M:Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync(System.Func{Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})" /> or
<see cref="M:Microsoft.ServiceFabric.Data.IStateProviderReplica.BackupAsync(Microsoft.ServiceFabric.Data.BackupOption,System.TimeSpan,System.Threading.CancellationToken,System.Func{Microsoft.ServiceFabric.Data.BackupInfo,System.Threading.CancellationToken,System.Threading.Tasks.Task{System.Boolean}})" />.
</summary>
<returns>Task that represents the asynchronous restore operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnDataLossAsync">
<MemberSignature Language="C#" Value="public Func<System.Threading.CancellationToken,System.Threading.Tasks.Task<bool>> OnDataLossAsync { set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task`1<bool>> OnDataLossAsync" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.OnDataLossAsync" />
<MemberSignature Language="VB.NET" Value="Public Property OnDataLossAsync As Func(Of CancellationToken, Task(Of Boolean))" />
<MemberSignature Language="F#" Value="member this.OnDataLossAsync : Func<System.Threading.CancellationToken, System.Threading.Tasks.Task<bool>>" Usage="Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.OnDataLossAsync" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<System.Threading.CancellationToken,System.Threading.Tasks.Task<System.Boolean>></ReturnType>
</ReturnValue>
<Docs>
<summary>
Sets the function to be called during suspected data-loss.
</summary>
<value>
A function representing data-loss callback function.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnRestoreCompletedAsync">
<MemberSignature Language="C#" Value="public Func<System.Threading.CancellationToken,System.Threading.Tasks.Task> OnRestoreCompletedAsync { set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<valuetype System.Threading.CancellationToken, class System.Threading.Tasks.Task> OnRestoreCompletedAsync" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.OnRestoreCompletedAsync" />
<MemberSignature Language="VB.NET" Value="Public Property OnRestoreCompletedAsync As Func(Of CancellationToken, Task)" />
<MemberSignature Language="F#" Value="member this.OnRestoreCompletedAsync : Func<System.Threading.CancellationToken, System.Threading.Tasks.Task>" Usage="Microsoft.ServiceFabric.Actors.Runtime.KvsActorStateProviderBase.OnRestoreCompletedAsync" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<System.Threading.CancellationToken,System.Threading.Tasks.Task></ReturnType>
</ReturnValue>
<Docs>
<summary>
Sets the function to be called after the partition state has been restored automatically by the system
</summary>
<value>
A function representing on restore completed callback function.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>