-
Notifications
You must be signed in to change notification settings - Fork 256
/
IActorStateManager.xml
517 lines (517 loc) · 35.6 KB
/
IActorStateManager.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
<Type Name="IActorStateManager" FullName="Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager">
<TypeSignature Language="C#" Value="public interface IActorStateManager" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IActorStateManager" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager" />
<TypeSignature Language="VB.NET" Value="Public Interface IActorStateManager" />
<TypeSignature Language="F#" Value="type IActorStateManager = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Represents an interface that exposes methods to manage state of an <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.Actor" />.
This interface is implemented by <see cref="P:Microsoft.ServiceFabric.Actors.Runtime.Actor.StateManager" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddOrUpdateStateAsync<T>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<T> AddOrUpdateStateAsync<T> (string stateName, T addValue, Func<string,T,T> updateValueFactory, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!!T> AddOrUpdateStateAsync<T>(string stateName, !!T addValue, class System.Func`3<string, !!T, !!T> updateValueFactory, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.AddOrUpdateStateAsync``1(System.String,``0,System.Func{System.String,``0,``0},System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function AddOrUpdateStateAsync(Of T) (stateName As String, addValue As T, updateValueFactory As Func(Of String, T, T), Optional cancellationToken As CancellationToken = Nothing) As Task(Of T)" />
<MemberSignature Language="F#" Value="abstract member AddOrUpdateStateAsync : string * 'T * Func<string, 'T, 'T> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>" Usage="iActorStateManager.AddOrUpdateStateAsync (stateName, addValue, updateValueFactory, cancellationToken)" />
<MemberType>Method</MemberType>
<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="stateName" Type="System.String" />
<Parameter Name="addValue" Type="T" />
<Parameter Name="updateValueFactory" Type="System.Func<System.String,T,T>" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">Type of value associated with given state name.</typeparam>
<param name="stateName">Name of the actor state to add or update.</param>
<param name="addValue">Value of the actor state to add if it does not exist.</param>
<param name="updateValueFactory">Factory function to generate value of actor state to update if it exists.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Adds an actor state with given state name, if it does not already exist or updates
the state with specified state name, if it exists.
</summary>
<returns>
A task that represents the asynchronous add/update operation. The value of TResult
parameter contains value of actor state that was added/updated.
</returns>
<remarks>
The type of state value <typeparamref name="T" /> must be
<see href="https://msdn.microsoft.com/library/ms731923.aspx">Data Contract</see> serializable.
</remarks>
<exception cref="T:System.ArgumentNullException"> The specified state name is null.</exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="AddStateAsync<T>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task AddStateAsync<T> (string stateName, T value, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task AddStateAsync<T>(string stateName, !!T value, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.AddStateAsync``1(System.String,``0,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function AddStateAsync(Of T) (stateName As String, value As T, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member AddStateAsync : string * 'T * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateManager.AddStateAsync (stateName, value, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="stateName" Type="System.String" />
<Parameter Name="value" Type="T" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">Type of value associated with given state name.</typeparam>
<param name="stateName">Name of the actor state to add.</param>
<param name="value">Value of the actor state to add.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Adds an actor state with given state name.
</summary>
<returns>
A task that represents the asynchronous add operation.
</returns>
<remarks>
The type of state value <typeparamref name="T" /> must be
<see href="https://msdn.microsoft.com/library/ms731923.aspx">Data Contract</see> serializable.
</remarks>
<exception cref="T:System.InvalidOperationException">
An actor state with given state name already exists.
</exception>
<exception cref="T:System.ArgumentNullException">The specified state name is null.</exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="ClearCacheAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task ClearCacheAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task ClearCacheAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.ClearCacheAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ClearCacheAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member ClearCacheAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateManager.ClearCacheAsync cancellationToken" />
<MemberType>Method</MemberType>
<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>
Clears all the cached actor states and any operation(s) performed on <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager" />
since last state save operation.
</summary>
<returns>
A task that represents the asynchronous clear cache operation.
</returns>
<remarks>
All the operation(s) performed on <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager" /> since last save operation are cleared on
clearing the cache and will not be included in next save operation.
</remarks>
</Docs>
</Member>
<Member MemberName="ContainsStateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> ContainsStateAsync (string stateName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> ContainsStateAsync(string stateName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.ContainsStateAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ContainsStateAsync (stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member ContainsStateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>" Usage="iActorStateManager.ContainsStateAsync (stateName, cancellationToken)" />
<MemberType>Method</MemberType>
<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="stateName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="stateName">Name of the actor state.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Checks if an actor state with specified name exists.
</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.ArgumentNullException"> The specified state name is null.</exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="GetOrAddStateAsync<T>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<T> GetOrAddStateAsync<T> (string stateName, T value, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!!T> GetOrAddStateAsync<T>(string stateName, !!T value, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.GetOrAddStateAsync``1(System.String,``0,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetOrAddStateAsync(Of T) (stateName As String, value As T, Optional cancellationToken As CancellationToken = Nothing) As Task(Of T)" />
<MemberSignature Language="F#" Value="abstract member GetOrAddStateAsync : string * 'T * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>" Usage="iActorStateManager.GetOrAddStateAsync (stateName, value, cancellationToken)" />
<MemberType>Method</MemberType>
<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="stateName" Type="System.String" />
<Parameter Name="value" Type="T" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">Type of value associated with given state name.</typeparam>
<param name="stateName">Name of the actor state to get or add.</param>
<param name="value">Value of the actor state to add if it does not exist.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Gets an actor state with the given state name if it exists. If it does not
exist, creates and new state with the specified name and value.
</summary>
<returns>
A task that represents the asynchronous get or add operation. The value of TResult
parameter contains value of actor state with given state name.
</returns>
<remarks>
The type of state value <typeparamref name="T" /> must be
<see href="https://msdn.microsoft.com/library/ms731923.aspx">Data Contract</see> serializable.
</remarks>
<exception cref="T:System.ArgumentNullException"> The specified state name is null.
Provide a valid state name string.</exception>
<exception cref="T:System.OperationCanceledException">The request was canceled using the specified
<paramref name="cancellationToken" />.</exception>
</Docs>
</Member>
<Member MemberName="GetStateAsync<T>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<T> GetStateAsync<T> (string stateName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!!T> GetStateAsync<T>(string stateName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.GetStateAsync``1(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetStateAsync(Of T) (stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of T)" />
<MemberSignature Language="F#" Value="abstract member GetStateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<'T>" Usage="iActorStateManager.GetStateAsync (stateName, cancellationToken)" />
<MemberType>Method</MemberType>
<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="stateName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">Type of value associated with given state name.</typeparam>
<param name="stateName">Name of the actor state to get.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Gets an actor state with specified state name.
</summary>
<returns>
A task that represents the asynchronous get operation. The value of TResult
parameter contains value of actor state with given state name.
</returns>
<remarks>
The type of state value <typeparamref name="T" /> must be
<see href="https://msdn.microsoft.com/library/ms731923.aspx">Data Contract</see> serializable.
</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">
An actor state with given state name does not exist.
</exception>
<exception cref="T:System.ArgumentNullException">The specified state name is null.</exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="GetStateNamesAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<string>> GetStateNamesAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<string>> GetStateNamesAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.GetStateNamesAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetStateNamesAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of String))" />
<MemberSignature Language="F#" Value="abstract member GetStateNamesAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<string>>" Usage="iActorStateManager.GetStateNamesAsync cancellationToken" />
<MemberType>Method</MemberType>
<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="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Creates an enumerable of all actor state names for current actor.
</summary>
<returns>
A task that represents the asynchronous enumeration operation. The value of TResult
parameter is an enumerable of all actor state names.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="RemoveStateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RemoveStateAsync (string stateName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task RemoveStateAsync(string stateName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.RemoveStateAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function RemoveStateAsync (stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member RemoveStateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateManager.RemoveStateAsync (stateName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stateName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="stateName">Name of the actor state to remove.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Removes an actor state with specified state name.
</summary>
<returns>A task that represents the asynchronous remove operation.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Collections.Generic.KeyNotFoundException">
An actor state with given state name does not exist.
</exception>
<exception cref="T:System.ArgumentNullException"> The specified state name is null. </exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="SaveStateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SaveStateAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SaveStateAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.SaveStateAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SaveStateAsync (Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member SaveStateAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateManager.SaveStateAsync cancellationToken" />
<MemberType>Method</MemberType>
<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>
Saves all the cached state changes (add/update/remove) that were made since last call to
<see cref="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.SaveStateAsync(System.Threading.CancellationToken)" /> by actor runtime or by user explicitly.
</summary>
<returns>
A task that represents the asynchronous save operation.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetStateAsync<T>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task SetStateAsync<T> (string stateName, T value, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task SetStateAsync<T>(string stateName, !!T value, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.SetStateAsync``1(System.String,``0,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function SetStateAsync(Of T) (stateName As String, value As T, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="abstract member SetStateAsync : string * 'T * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="iActorStateManager.SetStateAsync (stateName, value, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="stateName" Type="System.String" />
<Parameter Name="value" Type="T" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">Type of value associated with given state name.</typeparam>
<param name="stateName">Name of the actor state to set.</param>
<param name="value">Value of the actor state.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Sets an actor state with given state name to specified value.
If an actor state with specified name does not exist, it is added.
</summary>
<returns>
A task that represents the asynchronous set operation.
</returns>
<remarks>
The type of state value <typeparamref name="T" /> must be
<see href="https://msdn.microsoft.com/library/ms731923.aspx">Data Contract</see> serializable.
</remarks>
<exception cref="T:System.ArgumentNullException">The specified state name is null.</exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="TryAddStateAsync<T>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> TryAddStateAsync<T> (string stateName, T value, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> TryAddStateAsync<T>(string stateName, !!T value, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.TryAddStateAsync``1(System.String,``0,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function TryAddStateAsync(Of T) (stateName As String, value As T, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member TryAddStateAsync : string * 'T * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>" Usage="iActorStateManager.TryAddStateAsync (stateName, value, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Boolean></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="stateName" Type="System.String" />
<Parameter Name="value" Type="T" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">Type of value associated with given state name.</typeparam>
<param name="stateName">Name of the actor state to add.</param>
<param name="value">Value of the actor state to add.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.
This is optional and defaults to <see cref="P:System.Threading.CancellationToken.None" /></param>
<summary>
Attempts to add an actor state with given state name and value. Returns false if an actor state with
the same name already exists.
</summary>
<returns>
A boolean task that represents the asynchronous add operation. Returns true if the
value was successfully added and false if an actor state with the same name already exists.
</returns>
<remarks>
The type of state value <typeparamref name="T" /> must be
<see href="https://msdn.microsoft.com/library/ms731923.aspx">Data Contract</see> serializable.
</remarks>
<exception cref="T:System.ArgumentNullException">The specified state name is null.
Provide a valid state name string.</exception>
<exception cref="T:System.OperationCanceledException">The request was canceled using the specified
<paramref name="cancellationToken" />.</exception>
</Docs>
</Member>
<Member MemberName="TryGetStateAsync<T>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<T>> TryGetStateAsync<T> (string stateName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<valuetype Microsoft.ServiceFabric.Data.ConditionalValue`1<!!T>> TryGetStateAsync<T>(string stateName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.TryGetStateAsync``1(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetStateAsync(Of T) (stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ConditionalValue(Of T))" />
<MemberSignature Language="F#" Value="abstract member TryGetStateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<'T>>" Usage="iActorStateManager.TryGetStateAsync (stateName, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Data.ConditionalValue<T>></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="stateName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="T">Type of value associated with given state name.</typeparam>
<param name="stateName">Name of the actor state to get.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Attempts to get an actor state with specified state name.
</summary>
<returns>
A task that represents the asynchronous get operation. The value of TResult
parameter contains <see cref="T:Microsoft.ServiceFabric.Data.ConditionalValue`1" />
indicating whether the actor state is present and the value of actor state if it is present.
</returns>
<remarks>
The type of state value <typeparamref name="T" /> must be
<see href="https://msdn.microsoft.com/library/ms731923.aspx">Data Contract</see> serializable.
</remarks>
<exception cref="T:System.ArgumentNullException">The specified state name is null.</exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
<Member MemberName="TryRemoveStateAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<bool> TryRemoveStateAsync (string stateName, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<bool> TryRemoveStateAsync(string stateName, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.IActorStateManager.TryRemoveStateAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function TryRemoveStateAsync (stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)" />
<MemberSignature Language="F#" Value="abstract member TryRemoveStateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>" Usage="iActorStateManager.TryRemoveStateAsync (stateName, cancellationToken)" />
<MemberType>Method</MemberType>
<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="stateName" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="stateName">Name of the actor state to remove.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Attempts to remove an actor state with specified state name.
</summary>
<returns>
A task that represents the asynchronous remove operation. The value of TResult
parameter indicates if the state was successfully removed.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException"> The specified state name is null.</exception>
<exception cref="T:System.OperationCanceledException">The operation was canceled.</exception>
</Docs>
</Member>
</Members>
</Type>