-
Notifications
You must be signed in to change notification settings - Fork 254
/
ActorServiceAttribute.xml
80 lines (80 loc) · 4.23 KB
/
ActorServiceAttribute.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
<Type Name="ActorServiceAttribute" FullName="Microsoft.ServiceFabric.Actors.Runtime.ActorServiceAttribute">
<TypeSignature Language="C#" Value="public sealed class ActorServiceAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ActorServiceAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Actors.Runtime.ActorServiceAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ActorServiceAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type ActorServiceAttribute = class
 inherit Attribute" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Class)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Class)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Represents the attributes that allows configuring the properties of the actor service.
The attribute is applied on the actor type.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ActorServiceAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Runtime.ActorServiceAttribute.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.ActorServiceAttribute" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Actors.Runtime.ActorServiceAttribute.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.ServiceFabric.Actors.Runtime.ActorServiceAttribute.Name" />
<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 or sets the relative name of the actor service. This name will be combined with the application name to provide the full name of the
actor service.
</summary>
<value>The name of the actor service relative to the application name.</value>
<remarks>
<para>
By default, the actor service name is derived from the type of the actor interface
(<see cref="M:Microsoft.ServiceFabric.Actors.Generator.ActorNameFormat.GetFabricServiceName(System.Type,System.String)" />).
However, in case when an actor interface is implemented by more than one actor, including by a derived type,
the name cannot be determined from the actor interface in an unambiguous manner.
In that case, the name of the actor service must be configured using this property of the
<see cref="T:Microsoft.ServiceFabric.Actors.Runtime.ActorServiceAttribute" />.
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>