-
Notifications
You must be signed in to change notification settings - Fork 256
/
ActorProxy.xml
203 lines (203 loc) · 13.7 KB
/
ActorProxy.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
<Type Name="ActorProxy" FullName="Microsoft.ServiceFabric.Actors.Client.ActorProxy">
<TypeSignature Language="C#" Value="public abstract class ActorProxy : Microsoft.ServiceFabric.Services.Remoting.Builder.ProxyBase, Microsoft.ServiceFabric.Actors.Client.IActorProxy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ActorProxy extends Microsoft.ServiceFabric.Services.Remoting.Builder.ProxyBase implements class Microsoft.ServiceFabric.Actors.Client.IActorProxy" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Actors.Client.ActorProxy" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ActorProxy
Inherits ProxyBase
Implements IActorProxy" />
<TypeSignature Language="F#" Value="type ActorProxy = class
 inherit ProxyBase
 interface IActorProxy" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.ServiceFabric.Services.Remoting.Builder.ProxyBase</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.ServiceFabric.Actors.Client.IActorProxy</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Provides the base implementation for the proxy to the remote actor objects implementing <see cref="T:Microsoft.ServiceFabric.Actors.IActor" /> interfaces.
The proxy object can be used used for client-to-actor and actor-to-actor communication.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ActorProxy ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Client.ActorProxy.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected 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.Client.ActorProxy" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ActorId">
<MemberSignature Language="C#" Value="public Microsoft.ServiceFabric.Actors.ActorId ActorId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceFabric.Actors.ActorId ActorId" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Actors.Client.ActorProxy.ActorId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ActorId As ActorId" />
<MemberSignature Language="F#" Value="member this.ActorId : Microsoft.ServiceFabric.Actors.ActorId" Usage="Microsoft.ServiceFabric.Actors.Client.ActorProxy.ActorId" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.ServiceFabric.Actors.Client.IActorProxy.ActorId</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceFabric.Actors.ActorId</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets <see cref="T:Microsoft.ServiceFabric.Actors.ActorId" /> associated with the proxy object.
</summary>
<value>
<see cref="T:Microsoft.ServiceFabric.Actors.ActorId" /> associated with the proxy object.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ActorServicePartitionClientV2">
<MemberSignature Language="C#" Value="public Microsoft.ServiceFabric.Actors.Remoting.V2.Client.IActorServicePartitionClient ActorServicePartitionClientV2 { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.ServiceFabric.Actors.Remoting.V2.Client.IActorServicePartitionClient ActorServicePartitionClientV2" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Actors.Client.ActorProxy.ActorServicePartitionClientV2" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ActorServicePartitionClientV2 As IActorServicePartitionClient" />
<MemberSignature Language="F#" Value="member this.ActorServicePartitionClientV2 : Microsoft.ServiceFabric.Actors.Remoting.V2.Client.IActorServicePartitionClient" Usage="Microsoft.ServiceFabric.Actors.Client.ActorProxy.ActorServicePartitionClientV2" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.ServiceFabric.Actors.Client.IActorProxy.ActorServicePartitionClientV2</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceFabric.Actors.Remoting.V2.Client.IActorServicePartitionClient</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Microsoft.ServiceFabric.Actors.Remoting.V2.Client.IActorServicePartitionClient" /> interface that this proxy is using to communicate with the actor.
</summary>
<value>
<see cref="T:Microsoft.ServiceFabric.Actors.Remoting.V2.Client.IActorServicePartitionClient" /> that this proxy is using to communicate with the actor.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create<TActorInterface>">
<MemberSignature Language="C#" Value="public static TActorInterface Create<TActorInterface> (Microsoft.ServiceFabric.Actors.ActorId actorId, Uri serviceUri, string listenerName = default) where TActorInterface : Microsoft.ServiceFabric.Actors.IActor;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TActorInterface Create<(class Microsoft.ServiceFabric.Actors.IActor) TActorInterface>(class Microsoft.ServiceFabric.Actors.ActorId actorId, class System.Uri serviceUri, string listenerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Client.ActorProxy.Create``1(Microsoft.ServiceFabric.Actors.ActorId,System.Uri,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Create(Of TActorInterface As IActor) (actorId As ActorId, serviceUri As Uri, Optional listenerName As String = Nothing) As TActorInterface" />
<MemberSignature Language="F#" Value="static member Create : Microsoft.ServiceFabric.Actors.ActorId * Uri * string -> 'ActorInterface (requires 'ActorInterface :> Microsoft.ServiceFabric.Actors.IActor)" Usage="Microsoft.ServiceFabric.Actors.Client.ActorProxy.Create (actorId, serviceUri, listenerName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TActorInterface</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TActorInterface">
<Constraints>
<InterfaceName>Microsoft.ServiceFabric.Actors.IActor</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="serviceUri" Type="System.Uri" />
<Parameter Name="listenerName" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TActorInterface">
The actor interface implemented by the remote actor object.
The returned proxy object will implement this interface.
</typeparam>
<param name="actorId">Actor Id of the proxy actor object. Methods called on this proxy will result in requests
being sent to the actor with this id.</param>
<param name="serviceUri">Uri of the actor service.</param>
<param name="listenerName">
By default an actor service has only one listener for clients to connect to and communicate with.
However it is possible to configure an actor service with more than one listeners, the listenerName parameter specifies the name of the listener to connect to.
</param>
<summary>
Creates a proxy to the actor object that implements an actor interface.
</summary>
<returns>An actor proxy object that implements <see cref="T:Microsoft.ServiceFabric.Actors.Client.IActorProxy" /> and TActorInterface.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Create<TActorInterface>">
<MemberSignature Language="C#" Value="public static TActorInterface Create<TActorInterface> (Microsoft.ServiceFabric.Actors.ActorId actorId, string applicationName = default, string serviceName = default, string listenerName = default) where TActorInterface : Microsoft.ServiceFabric.Actors.IActor;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TActorInterface Create<(class Microsoft.ServiceFabric.Actors.IActor) TActorInterface>(class Microsoft.ServiceFabric.Actors.ActorId actorId, string applicationName, string serviceName, string listenerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Client.ActorProxy.Create``1(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Create(Of TActorInterface As IActor) (actorId As ActorId, Optional applicationName As String = Nothing, Optional serviceName As String = Nothing, Optional listenerName As String = Nothing) As TActorInterface" />
<MemberSignature Language="F#" Value="static member Create : Microsoft.ServiceFabric.Actors.ActorId * string * string * string -> 'ActorInterface (requires 'ActorInterface :> Microsoft.ServiceFabric.Actors.IActor)" Usage="Microsoft.ServiceFabric.Actors.Client.ActorProxy.Create (actorId, applicationName, serviceName, listenerName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TActorInterface</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TActorInterface">
<Constraints>
<InterfaceName>Microsoft.ServiceFabric.Actors.IActor</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="applicationName" Type="System.String" />
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="listenerName" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TActorInterface">
The actor interface implemented by the remote actor object.
The returned proxy object will implement this interface.
</typeparam>
<param name="actorId">The actor ID of the proxy actor object. Methods called on this proxy will result in requests
being sent to the actor with this ID.</param>
<param name="applicationName">
The name of the Service Fabric application that contains the actor service hosting the actor objects.
This parameter can be null if the client is running as part of that same Service Fabric application. For more information, see Remarks.
</param>
<param name="serviceName">
The name of the Service Fabric service as configured by <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.ActorServiceAttribute" /> on the actor implementation.
By default, the name of the service is derived from the name of the actor interface. However, <see cref="T:Microsoft.ServiceFabric.Actors.Runtime.ActorServiceAttribute" />
is required when an actor implements more than one actor interface or an actor interface derives from another actor interface since
the service name cannot be determined automatically.
</param>
<param name="listenerName">
By default an actor service has only one listener for clients to connect to and communicate with.
However, it is possible to configure an actor service with more than one listener. This parameter specifies the name of the listener to connect to.
</param>
<summary>
Creates a proxy to the actor object that implements an actor interface.
</summary>
<returns>An actor proxy object that implements <see cref="T:Microsoft.ServiceFabric.Actors.Client.IActorProxy" /> and TActorInterface.</returns>
<remarks>
<para>The applicationName parameter can be null if the client is running as part of the same Service Fabric
application as the actor service it intends to communicate with. In this case, the application name is determined from
<see cref="T:System.Fabric.CodePackageActivationContext" />, and is obtained by calling the
<see cref="P:System.Fabric.CodePackageActivationContext.ApplicationName" /> property.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>