-
Notifications
You must be signed in to change notification settings - Fork 255
/
ActorBase.xml
428 lines (428 loc) · 28.2 KB
/
ActorBase.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
<Type Name="ActorBase" FullName="Microsoft.ServiceFabric.Actors.Runtime.ActorBase">
<TypeSignature Language="C#" Value="public abstract class ActorBase" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ActorBase extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Actors.Runtime.ActorBase" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ActorBase" />
<TypeSignature Language="F#" Value="type ActorBase = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents the base class for actors.
</summary>
<remarks>
The base type for actors, that provides the common functionality
for actors that derive from <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.Actor" />.
The state is preserved across actor garbage collections and fail-overs.
The storage and retrieval of the state is provided by the actor state provider. See
<see cref="T:Microsoft.ServiceFabric.Actors.Runtime.IActorStateProvider" /> for more information.
</remarks>
<altmember cref="T:Microsoft.ServiceFabric.Actors.Runtime.Actor" />
</Docs>
<Members>
<Member MemberName="ActorService">
<MemberSignature Language="C#" Value="public Microsoft.ServiceFabric.Actors.Runtime.ActorService ActorService { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceFabric.Actors.Runtime.ActorService ActorService" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.ActorService" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ActorService As ActorService" />
<MemberSignature Language="F#" Value="member this.ActorService : Microsoft.ServiceFabric.Actors.Runtime.ActorService" Usage="Microsoft.ServiceFabric.Actors.Runtime.ActorBase.ActorService" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceFabric.Actors.Runtime.ActorService</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the stateful service replica that is hosting the actor.
</summary>
<value>
The <see cref="P:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.ActorService" /> that represents the stateful service replica hosting the actor.
</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ApplicationName">
<MemberSignature Language="C#" Value="public string ApplicationName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ApplicationName" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.ApplicationName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ApplicationName As String" />
<MemberSignature Language="F#" Value="member this.ApplicationName : string" Usage="Microsoft.ServiceFabric.Actors.Runtime.ActorBase.ApplicationName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the application that contains the actor service that is hosting this actor.
</summary>
<value>The name of application that contains the actor service that is hosting this actor.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetEvent<TEvent>">
<MemberSignature Language="C#" Value="protected TEvent GetEvent<TEvent> ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance !!TEvent GetEvent<TEvent>() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.GetEvent``1" />
<MemberSignature Language="VB.NET" Value="Protected Function GetEvent(Of TEvent) () As TEvent" />
<MemberSignature Language="F#" Value="member this.GetEvent : unit -> 'Event" Usage="actorBase.GetEvent " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TEvent</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TEvent" />
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="TEvent">The Event interface type.</typeparam>
<summary>
Gets the event for the specified event interface.
</summary>
<returns>Returns an Event that represents the specified interface.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetReminder">
<MemberSignature Language="C#" Value="protected Microsoft.ServiceFabric.Actors.Runtime.IActorReminder GetReminder (string reminderName);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance class Microsoft.ServiceFabric.Actors.Runtime.IActorReminder GetReminder(string reminderName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.GetReminder(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Function GetReminder (reminderName As String) As IActorReminder" />
<MemberSignature Language="F#" Value="member this.GetReminder : string -> Microsoft.ServiceFabric.Actors.Runtime.IActorReminder" Usage="actorBase.GetReminder reminderName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceFabric.Actors.Runtime.IActorReminder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reminderName" Type="System.String" />
</Parameters>
<Docs>
<param name="reminderName">The Name of the reminder to get.</param>
<summary>
Gets the actor reminder with specified reminder name.
</summary>
<returns>
An <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.IActorReminder" /> that represents an actor reminder.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.ServiceFabric.Actors.ReminderNotFoundException">Reminder not found for the actor.</exception>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public Microsoft.ServiceFabric.Actors.ActorId Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceFabric.Actors.ActorId Id" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.Id" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Id As ActorId" />
<MemberSignature Language="F#" Value="member this.Id : Microsoft.ServiceFabric.Actors.ActorId" Usage="Microsoft.ServiceFabric.Actors.Runtime.ActorBase.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceFabric.Actors.ActorId</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the identity of this actor with the actor service.
</summary>
<value>The <see cref="T:Microsoft.ServiceFabric.Actors.ActorId" /> for the actor.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnActivateAsync">
<MemberSignature Language="C#" Value="protected virtual System.Threading.Tasks.Task OnActivateAsync ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task OnActivateAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.OnActivateAsync" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function OnActivateAsync () As Task" />
<MemberSignature Language="F#" Value="abstract member OnActivateAsync : unit -> System.Threading.Tasks.Task
override this.OnActivateAsync : unit -> System.Threading.Tasks.Task" Usage="actorBase.OnActivateAsync " />
<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 />
<Docs>
<summary>
Override this method to initialize the members, initialize state or register timers. This method is called right after the actor is activated
and before any method call or reminders are dispatched on it.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task">Task</see> that represents outstanding OnActivateAsync operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnDeactivateAsync">
<MemberSignature Language="C#" Value="protected virtual System.Threading.Tasks.Task OnDeactivateAsync ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task OnDeactivateAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.OnDeactivateAsync" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function OnDeactivateAsync () As Task" />
<MemberSignature Language="F#" Value="abstract member OnDeactivateAsync : unit -> System.Threading.Tasks.Task
override this.OnDeactivateAsync : unit -> System.Threading.Tasks.Task" Usage="actorBase.OnDeactivateAsync " />
<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 />
<Docs>
<summary>
Override this method to release any resources. This method is called when actor is deactivated (garbage collected by Actor Runtime).
Actor operations like state changes should not be called from this method.
</summary>
<returns>A <see cref="T:System.Threading.Tasks.Task">Task</see> that represents outstanding OnDeactivateAsync operation.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnPostActorMethodAsync">
<MemberSignature Language="C#" Value="protected virtual System.Threading.Tasks.Task OnPostActorMethodAsync (Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext actorMethodContext);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task OnPostActorMethodAsync(valuetype Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext actorMethodContext) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.OnPostActorMethodAsync(Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function OnPostActorMethodAsync (actorMethodContext As ActorMethodContext) As Task" />
<MemberSignature Language="F#" Value="abstract member OnPostActorMethodAsync : Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext -> System.Threading.Tasks.Task
override this.OnPostActorMethodAsync : Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext -> System.Threading.Tasks.Task" Usage="actorBase.OnPostActorMethodAsync actorMethodContext" />
<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="actorMethodContext" Type="Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext" />
</Parameters>
<Docs>
<param name="actorMethodContext">
An <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext" /> describing the method that was invoked by actor runtime prior to this method.
</param>
<summary>
Override this method for performing any actions after an actor method has finished execution.
This method is invoked by actor runtime an actor method has finished execution.
</summary>
<returns>
Returns a <see cref="T:System.Threading.Tasks.Task">Task</see> representing post-actor-method operation.
</returns>
<remarks>
This method is invoked by actor runtime prior to:
<list type="bullet"><item><description>Invoking an actor interface method when a client request comes.</description></item><item><description>Invoking a method on <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.IRemindable" /> interface when a reminder fires.</description></item><item><description>Invoking a timer callback when timer fires.</description></item></list></remarks>
</Docs>
</Member>
<Member MemberName="OnPreActorMethodAsync">
<MemberSignature Language="C#" Value="protected virtual System.Threading.Tasks.Task OnPreActorMethodAsync (Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext actorMethodContext);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Threading.Tasks.Task OnPreActorMethodAsync(valuetype Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext actorMethodContext) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.OnPreActorMethodAsync(Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function OnPreActorMethodAsync (actorMethodContext As ActorMethodContext) As Task" />
<MemberSignature Language="F#" Value="abstract member OnPreActorMethodAsync : Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext -> System.Threading.Tasks.Task
override this.OnPreActorMethodAsync : Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext -> System.Threading.Tasks.Task" Usage="actorBase.OnPreActorMethodAsync actorMethodContext" />
<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="actorMethodContext" Type="Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext" />
</Parameters>
<Docs>
<param name="actorMethodContext">
An <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.ActorMethodContext" /> describing the method that will be invoked by actor runtime after this method finishes.
</param>
<summary>
Override this method for performing any actions prior to an actor method is invoked.
This method is invoked by actor runtime just before invoking an actor method.
</summary>
<returns>
Returns a <see cref="T:System.Threading.Tasks.Task">Task</see> representing pre-actor-method operation.
</returns>
<remarks>
This method is invoked by actor runtime prior to:
<list type="bullet"><item><description>Invoking an actor interface method when a client request comes.</description></item><item><description>Invoking a method on <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.IRemindable" /> interface when a reminder fires.</description></item><item><description>Invoking a timer callback when timer fires.</description></item></list></remarks>
</Docs>
</Member>
<Member MemberName="RegisterReminderAsync">
<MemberSignature Language="C#" Value="protected System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminder> RegisterReminderAsync (string reminderName, byte[] state, TimeSpan dueTime, TimeSpan period);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.ServiceFabric.Actors.Runtime.IActorReminder> RegisterReminderAsync(string reminderName, unsigned int8[] state, valuetype System.TimeSpan dueTime, valuetype System.TimeSpan period) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.RegisterReminderAsync(System.String,System.Byte[],System.TimeSpan,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Protected Function RegisterReminderAsync (reminderName As String, state As Byte(), dueTime As TimeSpan, period As TimeSpan) As Task(Of IActorReminder)" />
<MemberSignature Language="F#" Value="member this.RegisterReminderAsync : string * byte[] * TimeSpan * TimeSpan -> System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminder>" Usage="actorBase.RegisterReminderAsync (reminderName, state, dueTime, period)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.ServiceFabric.Actors.Runtime.IActorReminder></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reminderName" Type="System.String" />
<Parameter Name="state" Type="System.Byte[]" />
<Parameter Name="dueTime" Type="System.TimeSpan" />
<Parameter Name="period" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="reminderName">The name of the reminder to register. The name must be unique per actor.</param>
<param name="state">User state passed to the reminder invocation.</param>
<param name="dueTime">The amount of time to delay before invoking the reminder for the first time. Specify negative one (-1) milliseconds to disable invocation. Specify zero (0) to invoke the reminder immediately after registration.
</param>
<param name="period">
The time interval between reminder invocations after the first invocation. Specify negative one (-1) milliseconds to disable periodic invocation.
</param>
<summary>
Registers a reminder with the actor.
</summary>
<returns>
A task that represents the asynchronous registration operation. The result of the task provides information about the registered reminder and is used to unregister the reminder using <see cref="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.UnregisterReminderAsync(Microsoft.ServiceFabric.Actors.Runtime.IActorReminder)" />.
</returns>
<remarks>
<para>
The class deriving from <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.ActorBase" /> must implement <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.IRemindable" /> to consume reminder invocations. Multiple reminders can be registered at any time, uniquely identified by <paramref name="reminderName" />. Existing reminders can also be updated by calling this method again. Reminder invocations are synchronized both with other reminders and other actor method callbacks.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="RegisterTimer">
<MemberSignature Language="C#" Value="protected Microsoft.ServiceFabric.Actors.Runtime.IActorTimer RegisterTimer (Func<object,System.Threading.Tasks.Task> asyncCallback, object state, TimeSpan dueTime, TimeSpan period);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance class Microsoft.ServiceFabric.Actors.Runtime.IActorTimer RegisterTimer(class System.Func`2<object, class System.Threading.Tasks.Task> asyncCallback, object state, valuetype System.TimeSpan dueTime, valuetype System.TimeSpan period) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.RegisterTimer(System.Func{System.Object,System.Threading.Tasks.Task},System.Object,System.TimeSpan,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Protected Function RegisterTimer (asyncCallback As Func(Of Object, Task), state As Object, dueTime As TimeSpan, period As TimeSpan) As IActorTimer" />
<MemberSignature Language="F#" Value="member this.RegisterTimer : Func<obj, System.Threading.Tasks.Task> * obj * TimeSpan * TimeSpan -> Microsoft.ServiceFabric.Actors.Runtime.IActorTimer" Usage="actorBase.RegisterTimer (asyncCallback, state, dueTime, period)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceFabric.Actors.Runtime.IActorTimer</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="asyncCallback" Type="System.Func<System.Object,System.Threading.Tasks.Task>" />
<Parameter Name="state" Type="System.Object" />
<Parameter Name="dueTime" Type="System.TimeSpan" />
<Parameter Name="period" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="asyncCallback">
A delegate that specifies a method to be called when the timer fires.
It has one parameter: the state object passed to RegisterTimer.
It returns a <see cref="T:System.Threading.Tasks.Task" /> representing the asynchronous operation.
</param>
<param name="state">An object containing information to be used by the callback method, or null.</param>
<param name="dueTime">The amount of time to delay before the async callback is first invoked.
Specify negative one (-1) milliseconds to prevent the timer from starting.
Specify zero (0) to start the timer immediately.
</param>
<param name="period">
The time interval between invocations of the async callback.
Specify negative one (-1) milliseconds to disable periodic signaling.</param>
<summary>
Registers a Timer for the actor.
</summary>
<returns>Returns IActorTimer object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ServiceUri">
<MemberSignature Language="C#" Value="public Uri ServiceUri { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Uri ServiceUri" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.ServiceUri" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ServiceUri As Uri" />
<MemberSignature Language="F#" Value="member this.ServiceUri : Uri" Usage="Microsoft.ServiceFabric.Actors.Runtime.ActorBase.ServiceUri" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Uri</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the URI of the actor service that is hosting this actor.
</summary>
<value>The <see cref="T:System.Uri" /> of the actor service that is hosting this actor.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UnregisterReminderAsync">
<MemberSignature Language="C#" Value="protected System.Threading.Tasks.Task UnregisterReminderAsync (Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance class System.Threading.Tasks.Task UnregisterReminderAsync(class Microsoft.ServiceFabric.Actors.Runtime.IActorReminder reminder) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.UnregisterReminderAsync(Microsoft.ServiceFabric.Actors.Runtime.IActorReminder)" />
<MemberSignature Language="VB.NET" Value="Protected Function UnregisterReminderAsync (reminder As IActorReminder) As Task" />
<MemberSignature Language="F#" Value="member this.UnregisterReminderAsync : Microsoft.ServiceFabric.Actors.Runtime.IActorReminder -> System.Threading.Tasks.Task" Usage="actorBase.UnregisterReminderAsync reminder" />
<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="reminder" Type="Microsoft.ServiceFabric.Actors.Runtime.IActorReminder" />
</Parameters>
<Docs>
<param name="reminder">The actor reminder to unregister.</param>
<summary>
Unregisters a reminder previously registered using <see cref="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.RegisterReminderAsync(System.String,System.Byte[],System.TimeSpan,System.TimeSpan)" />.
</summary>
<returns>
Returns a task that represents the asynchronous unregistration operation.
</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.Fabric.FabricException">
The specified reminder is not registered.
</exception>
</Docs>
</Member>
<Member MemberName="UnregisterTimer">
<MemberSignature Language="C#" Value="protected void UnregisterTimer (Microsoft.ServiceFabric.Actors.Runtime.IActorTimer timer);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig instance void UnregisterTimer(class Microsoft.ServiceFabric.Actors.Runtime.IActorTimer timer) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorBase.UnregisterTimer(Microsoft.ServiceFabric.Actors.Runtime.IActorTimer)" />
<MemberSignature Language="VB.NET" Value="Protected Sub UnregisterTimer (timer As IActorTimer)" />
<MemberSignature Language="F#" Value="member this.UnregisterTimer : Microsoft.ServiceFabric.Actors.Runtime.IActorTimer -> unit" Usage="actorBase.UnregisterTimer timer" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="timer" Type="Microsoft.ServiceFabric.Actors.Runtime.IActorTimer" />
</Parameters>
<Docs>
<param name="timer">An IActorTimer representing timer that needs to be unregistered.</param>
<summary>
Unregisters a Timer previously set on this actor.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>