/
ActorProxyFactory.xml
290 lines (290 loc) · 23 KB
/
ActorProxyFactory.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
<Type Name="ActorProxyFactory" FullName="Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory">
<TypeSignature Language="C#" Value="public class ActorProxyFactory : Microsoft.ServiceFabric.Actors.Client.IActorProxyFactory" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ActorProxyFactory extends System.Object implements class Microsoft.ServiceFabric.Actors.Client.IActorProxyFactory" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory" />
<TypeSignature Language="VB.NET" Value="Public Class ActorProxyFactory
Implements IActorProxyFactory" />
<TypeSignature Language="F#" Value="type ActorProxyFactory = class
 interface IActorProxyFactory" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.ServiceFabric.Actors.Client.IActorProxyFactory</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Represents a factory class to create a proxy to the remote actor objects.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ActorProxyFactory (Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory.#ctor(Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional retrySettings As OperationRetrySettings = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory : Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings -> Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory" Usage="new Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory retrySettings" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="retrySettings" Type="Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings" />
</Parameters>
<Docs>
<param name="retrySettings">Retry settings for the remote object calls made by proxy.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ActorProxyFactory (Func<Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingCallbackMessageHandler,Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingClientFactory> createServiceRemotingClientFactory, Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Func`2<class Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingCallbackMessageHandler, class Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingClientFactory> createServiceRemotingClientFactory, class Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings retrySettings) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory.#ctor(System.Func{Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingCallbackMessageHandler,Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingClientFactory},Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (createServiceRemotingClientFactory As Func(Of IServiceRemotingCallbackMessageHandler, IServiceRemotingClientFactory), Optional retrySettings As OperationRetrySettings = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory : Func<Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingCallbackMessageHandler, Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingClientFactory> * Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings -> Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory" Usage="new Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory (createServiceRemotingClientFactory, retrySettings)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="createServiceRemotingClientFactory" Type="System.Func<Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingCallbackMessageHandler,Microsoft.ServiceFabric.Services.Remoting.V2.Client.IServiceRemotingClientFactory>" />
<Parameter Name="retrySettings" Type="Microsoft.ServiceFabric.Services.Communication.Client.OperationRetrySettings" />
</Parameters>
<Docs>
<param name="createServiceRemotingClientFactory">Factory method to create remoting communication client factory.</param>
<param name="retrySettings">Retry settings for the remote object calls made by proxy.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory" /> class using V2 Remoting Client Factory.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateActorProxy<TActorInterface>">
<MemberSignature Language="C#" Value="public TActorInterface CreateActorProxy<TActorInterface> (Uri serviceUri, Microsoft.ServiceFabric.Actors.ActorId actorId, string listenerName = default) where TActorInterface : Microsoft.ServiceFabric.Actors.IActor;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !!TActorInterface CreateActorProxy<(class Microsoft.ServiceFabric.Actors.IActor) TActorInterface>(class System.Uri serviceUri, class Microsoft.ServiceFabric.Actors.ActorId actorId, string listenerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory.CreateActorProxy``1(System.Uri,Microsoft.ServiceFabric.Actors.ActorId,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateActorProxy(Of TActorInterface As IActor) (serviceUri As Uri, actorId As ActorId, Optional listenerName As String = Nothing) As TActorInterface" />
<MemberSignature Language="F#" Value="abstract member CreateActorProxy : Uri * Microsoft.ServiceFabric.Actors.ActorId * string -> 'ActorInterface (requires 'ActorInterface :> Microsoft.ServiceFabric.Actors.IActor)
override this.CreateActorProxy : Uri * Microsoft.ServiceFabric.Actors.ActorId * string -> 'ActorInterface (requires 'ActorInterface :> Microsoft.ServiceFabric.Actors.IActor)" Usage="actorProxyFactory.CreateActorProxy (serviceUri, actorId, listenerName)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Client.IActorProxyFactory.CreateActorProxy``1(System.Uri,Microsoft.ServiceFabric.Actors.ActorId,System.String)</InterfaceMember>
</Implements>
<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="serviceUri" Type="System.Uri" />
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<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="serviceUri">Uri of the actor service.</param>
<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="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="CreateActorProxy<TActorInterface>">
<MemberSignature Language="C#" Value="public TActorInterface CreateActorProxy<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 hidebysig newslot virtual instance !!TActorInterface CreateActorProxy<(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.ActorProxyFactory.CreateActorProxy``1(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateActorProxy(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="abstract member CreateActorProxy : Microsoft.ServiceFabric.Actors.ActorId * string * string * string -> 'ActorInterface (requires 'ActorInterface :> Microsoft.ServiceFabric.Actors.IActor)
override this.CreateActorProxy : Microsoft.ServiceFabric.Actors.ActorId * string * string * string -> 'ActorInterface (requires 'ActorInterface :> Microsoft.ServiceFabric.Actors.IActor)" Usage="actorProxyFactory.CreateActorProxy (actorId, applicationName, serviceName, listenerName)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Client.IActorProxyFactory.CreateActorProxy``1(Microsoft.ServiceFabric.Actors.ActorId,System.String,System.String,System.String)</InterfaceMember>
</Implements>
<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">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">
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">
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 interfaces or an actor interface derives from another actor interface as the determination of the
serviceName cannot be made 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 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="CreateActorServiceProxy<TServiceInterface>">
<MemberSignature Language="C#" Value="public TServiceInterface CreateActorServiceProxy<TServiceInterface> (Uri serviceUri, Microsoft.ServiceFabric.Actors.ActorId actorId, string listenerName = default) where TServiceInterface : Microsoft.ServiceFabric.Services.Remoting.IService;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !!TServiceInterface CreateActorServiceProxy<(class Microsoft.ServiceFabric.Services.Remoting.IService) TServiceInterface>(class System.Uri serviceUri, class Microsoft.ServiceFabric.Actors.ActorId actorId, string listenerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory.CreateActorServiceProxy``1(System.Uri,Microsoft.ServiceFabric.Actors.ActorId,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateActorServiceProxy(Of TServiceInterface As IService) (serviceUri As Uri, actorId As ActorId, Optional listenerName As String = Nothing) As TServiceInterface" />
<MemberSignature Language="F#" Value="abstract member CreateActorServiceProxy : Uri * Microsoft.ServiceFabric.Actors.ActorId * string -> 'ServiceInterface (requires 'ServiceInterface :> Microsoft.ServiceFabric.Services.Remoting.IService)
override this.CreateActorServiceProxy : Uri * Microsoft.ServiceFabric.Actors.ActorId * string -> 'ServiceInterface (requires 'ServiceInterface :> Microsoft.ServiceFabric.Services.Remoting.IService)" Usage="actorProxyFactory.CreateActorServiceProxy (serviceUri, actorId, listenerName)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Client.IActorProxyFactory.CreateActorServiceProxy``1(System.Uri,Microsoft.ServiceFabric.Actors.ActorId,System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TServiceInterface</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TServiceInterface">
<Constraints>
<InterfaceName>Microsoft.ServiceFabric.Services.Remoting.IService</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="serviceUri" Type="System.Uri" />
<Parameter Name="actorId" Type="Microsoft.ServiceFabric.Actors.ActorId" />
<Parameter Name="listenerName" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TServiceInterface">The service interface implemented by the actor service.</typeparam>
<param name="serviceUri">Uri of the actor service to connect to.</param>
<param name="actorId">Id of the actor. The created proxy will be connected to the partition of the actor service hosting actor with this id.</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>
Create a proxy to the actor service that is hosting the specified actor id and implementing specified type of the service interface.
</summary>
<returns>A service proxy object that implements <see cref="T:Microsoft.ServiceFabric.Services.Remoting.Client.IServiceProxy" /> and TServiceInterface.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateActorServiceProxy<TServiceInterface>">
<MemberSignature Language="C#" Value="public TServiceInterface CreateActorServiceProxy<TServiceInterface> (Uri serviceUri, long partitionKey, string listenerName = default) where TServiceInterface : Microsoft.ServiceFabric.Services.Remoting.IService;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance !!TServiceInterface CreateActorServiceProxy<(class Microsoft.ServiceFabric.Services.Remoting.IService) TServiceInterface>(class System.Uri serviceUri, int64 partitionKey, string listenerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory.CreateActorServiceProxy``1(System.Uri,System.Int64,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function CreateActorServiceProxy(Of TServiceInterface As IService) (serviceUri As Uri, partitionKey As Long, Optional listenerName As String = Nothing) As TServiceInterface" />
<MemberSignature Language="F#" Value="abstract member CreateActorServiceProxy : Uri * int64 * string -> 'ServiceInterface (requires 'ServiceInterface :> Microsoft.ServiceFabric.Services.Remoting.IService)
override this.CreateActorServiceProxy : Uri * int64 * string -> 'ServiceInterface (requires 'ServiceInterface :> Microsoft.ServiceFabric.Services.Remoting.IService)" Usage="actorProxyFactory.CreateActorServiceProxy (serviceUri, partitionKey, listenerName)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.ServiceFabric.Actors.Client.IActorProxyFactory.CreateActorServiceProxy``1(System.Uri,System.Int64,System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>TServiceInterface</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TServiceInterface">
<Constraints>
<InterfaceName>Microsoft.ServiceFabric.Services.Remoting.IService</InterfaceName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="serviceUri" Type="System.Uri" />
<Parameter Name="partitionKey" Type="System.Int64" />
<Parameter Name="listenerName" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TServiceInterface">The service interface implemented by the actor service.</typeparam>
<param name="serviceUri">Uri of the actor service to connect to.</param>
<param name="partitionKey">The key of the actor service partition to connect to.</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>
Create a proxy to the actor service that is hosting the specified actor id and implementing specified type of the service interface.
</summary>
<returns>A service proxy object that implements <see cref="T:Microsoft.ServiceFabric.Services.Remoting.Client.IServiceProxy" /> and TServiceInterface.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Actors.Client.ActorProxyFactory.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="F#" Value="member this.Dispose : unit -> unit" Usage="actorProxyFactory.Dispose " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Actors</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Releases managed/unmanaged resources.
Dispose Method is being added rather than making it IDisposable so that it doesn't change type information and wont be a breaking change.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>