/
ActorRuntime.xml
97 lines (97 loc) · 7.84 KB
/
ActorRuntime.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
<Type Name="ActorRuntime" FullName="Microsoft.ServiceFabric.Actors.Runtime.ActorRuntime">
<TypeSignature Language="C#" Value="public static class ActorRuntime" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed ActorRuntime extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Actors.Runtime.ActorRuntime" />
<TypeSignature Language="VB.NET" Value="Public Class ActorRuntime" />
<TypeSignature Language="F#" Value="type ActorRuntime = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Contains methods to register actor and actor service types with Service Fabric runtime. Registering the types allows the runtime to create instances of the actor and the actor service. See https://docs.microsoft.com/azure/service-fabric/service-fabric-reliable-actors-lifecycle for more information on the lifecycle of an actor.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="RegisterActorAsync<TActor>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task RegisterActorAsync<TActor> (TimeSpan timeout = default, System.Threading.CancellationToken cancellationToken = default) where TActor : Microsoft.ServiceFabric.Actors.Runtime.ActorBase;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task RegisterActorAsync<(class Microsoft.ServiceFabric.Actors.Runtime.ActorBase) TActor>(valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorRuntime.RegisterActorAsync``1(System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function RegisterActorAsync(Of TActor As ActorBase) (Optional timeout As TimeSpan = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member RegisterActorAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task (requires 'Actor :> Microsoft.ServiceFabric.Actors.Runtime.ActorBase)" Usage="Microsoft.ServiceFabric.Actors.Runtime.ActorRuntime.RegisterActorAsync (timeout, 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="TActor">
<Constraints>
<BaseTypeName>Microsoft.ServiceFabric.Actors.Runtime.ActorBase</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="TActor">The type implementing the actor.</typeparam>
<param name="timeout">A timeout period after which the registration operation will be canceled.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Registers an actor type with Service Fabric runtime. This allows the runtime to create instances of this actor.
</summary>
<returns>returns a task that represents the asynchronous operation to register actor type with Service Fabric runtime.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RegisterActorAsync<TActor>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task RegisterActorAsync<TActor> (Func<System.Fabric.StatefulServiceContext,Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation,Microsoft.ServiceFabric.Actors.Runtime.ActorService> actorServiceFactory, TimeSpan timeout = default, System.Threading.CancellationToken cancellationToken = default) where TActor : Microsoft.ServiceFabric.Actors.Runtime.ActorBase;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task RegisterActorAsync<(class Microsoft.ServiceFabric.Actors.Runtime.ActorBase) TActor>(class System.Func`3<class System.Fabric.StatefulServiceContext, class Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation, class Microsoft.ServiceFabric.Actors.Runtime.ActorService> actorServiceFactory, valuetype System.TimeSpan timeout, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorRuntime.RegisterActorAsync``1(System.Func{System.Fabric.StatefulServiceContext,Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation,Microsoft.ServiceFabric.Actors.Runtime.ActorService},System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function RegisterActorAsync(Of TActor As ActorBase) (actorServiceFactory As Func(Of StatefulServiceContext, ActorTypeInformation, ActorService), Optional timeout As TimeSpan = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member RegisterActorAsync : Func<System.Fabric.StatefulServiceContext, Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation, Microsoft.ServiceFabric.Actors.Runtime.ActorService> * TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.Task (requires 'Actor :> Microsoft.ServiceFabric.Actors.Runtime.ActorBase)" Usage="Microsoft.ServiceFabric.Actors.Runtime.ActorRuntime.RegisterActorAsync (actorServiceFactory, timeout, 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="TActor">
<Constraints>
<BaseTypeName>Microsoft.ServiceFabric.Actors.Runtime.ActorBase</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="actorServiceFactory" Type="System.Func<System.Fabric.StatefulServiceContext,Microsoft.ServiceFabric.Actors.Runtime.ActorTypeInformation,Microsoft.ServiceFabric.Actors.Runtime.ActorService>" />
<Parameter Name="timeout" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<typeparam name="TActor">The Type implementing actor.</typeparam>
<param name="actorServiceFactory">The delegate that creates new actor service.</param>
<param name="timeout">A timeout period after which the registration operation will be canceled.</param>
<param name="cancellationToken">The token to monitor for cancellation requests.</param>
<summary>
Registers an actor service with Service Fabric runtime. This allows the runtime to create instances of the replicas for the actor service.
</summary>
<returns>A task that represents the asynchronous operation to register actor service with Service Fabric runtime.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>