-
Notifications
You must be signed in to change notification settings - Fork 256
/
ServiceEndpointCollection.xml
253 lines (253 loc) · 15.7 KB
/
ServiceEndpointCollection.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
<Type Name="ServiceEndpointCollection" FullName="Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection">
<TypeSignature Language="C#" Value="public sealed class ServiceEndpointCollection" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ServiceEndpointCollection extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ServiceEndpointCollection" />
<TypeSignature Language="F#" Value="type ServiceEndpointCollection = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.DataContract]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataContract>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
This class represents the endpoints of a Reliable service. Each endpoint has a listener name and the address of that listener.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceEndpointCollection ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection" /> class that is empty.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceEndpointCollection (string listenerName, string endpointAddress);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string listenerName, string endpointAddress) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.#ctor(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (listenerName As String, endpointAddress As String)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection : string * string -> Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection" Usage="new Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection (listenerName, endpointAddress)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="listenerName" Type="System.String" />
<Parameter Name="endpointAddress" Type="System.String" />
</Parameters>
<Docs>
<param name="listenerName">Listener name of the endpoint</param>
<param name="endpointAddress">Address of the endpoint</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection" /> class with a single endpoint, identified by the listener name.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddEndpoint">
<MemberSignature Language="C#" Value="public void AddEndpoint (string listenerName, string endpointAddress);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddEndpoint(string listenerName, string endpointAddress) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.AddEndpoint(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddEndpoint (listenerName As String, endpointAddress As String)" />
<MemberSignature Language="F#" Value="member this.AddEndpoint : string * string -> unit" Usage="serviceEndpointCollection.AddEndpoint (listenerName, endpointAddress)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="listenerName" Type="System.String" />
<Parameter Name="endpointAddress" Type="System.String" />
</Parameters>
<Docs>
<param name="listenerName">Listener name of the endpoint</param>
<param name="endpointAddress">Address of the endpoint</param>
<summary>
Adds an endpoint to the EndpointsCollection.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddEndpoints">
<MemberSignature Language="C#" Value="public void AddEndpoints (Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection newEndpoints);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddEndpoints(class Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection newEndpoints) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.AddEndpoints(Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddEndpoints (newEndpoints As ServiceEndpointCollection)" />
<MemberSignature Language="F#" Value="member this.AddEndpoints : Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection -> unit" Usage="serviceEndpointCollection.AddEndpoints newEndpoints" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="newEndpoints" Type="Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection" />
</Parameters>
<Docs>
<param name="newEndpoints">input EndpointsCollection</param>
<summary>
Adds the endpoints in the input EndpointsCollection class to the EndpointsCollection.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToReadOnlyDictionary">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IReadOnlyDictionary<string,string> ToReadOnlyDictionary ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Collections.Generic.IReadOnlyDictionary`2<string, string> ToReadOnlyDictionary() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.ToReadOnlyDictionary" />
<MemberSignature Language="VB.NET" Value="Public Function ToReadOnlyDictionary () As IReadOnlyDictionary(Of String, String)" />
<MemberSignature Language="F#" Value="member this.ToReadOnlyDictionary : unit -> System.Collections.Generic.IReadOnlyDictionary<string, string>" Usage="serviceEndpointCollection.ToReadOnlyDictionary " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IReadOnlyDictionary<System.String,System.String></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns a ReadOnlyDictionary of the endpointsCollection.
</summary>
<returns>EndpointsCollection as a ReadOnlyDictionary</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="serviceEndpointCollection.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Converts the endpointsCollection to a JSON string of the form
{"Endpoints":{"Listener1":"Endpoint1","Listener2":"Endpoint2" ...}}
</summary>
<returns>String form of the endpointsCollection</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetEndpointAddress">
<MemberSignature Language="C#" Value="public bool TryGetEndpointAddress (string listenerName, out string endpointAddress);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetEndpointAddress(string listenerName, [out] string& endpointAddress) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.TryGetEndpointAddress(System.String,System.String@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetEndpointAddress (listenerName As String, ByRef endpointAddress As String) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetEndpointAddress : string * string -> bool" Usage="serviceEndpointCollection.TryGetEndpointAddress (listenerName, endpointAddress)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="listenerName" Type="System.String" />
<Parameter Name="endpointAddress" Type="System.String" RefType="out" />
</Parameters>
<Docs>
<param name="listenerName">Listener name</param>
<param name="endpointAddress">Address of the endpoint if an endpoint with that listener name exists.</param>
<summary>
Gets the endpoint identified by the listener name.
</summary>
<returns>True if an endpoint with the listener name exists, False otherwise</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryGetFirstEndpointAddress">
<MemberSignature Language="C#" Value="public bool TryGetFirstEndpointAddress (out string endpointAddress);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool TryGetFirstEndpointAddress([out] string& endpointAddress) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.TryGetFirstEndpointAddress(System.String@)" />
<MemberSignature Language="VB.NET" Value="Public Function TryGetFirstEndpointAddress (ByRef endpointAddress As String) As Boolean" />
<MemberSignature Language="F#" Value="member this.TryGetFirstEndpointAddress : string -> bool" Usage="serviceEndpointCollection.TryGetFirstEndpointAddress endpointAddress" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="endpointAddress" Type="System.String" RefType="out" />
</Parameters>
<Docs>
<param name="endpointAddress">First endpoint in the EndpointsCollection</param>
<summary>
Gets the first endpoint address in the EndpointsCollection.
</summary>
<returns>True if there is at-least one endpoint in the EndpointsCollection, false otherwise</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TryParseEndpointsString">
<MemberSignature Language="C#" Value="public static bool TryParseEndpointsString (string endpointsString, out Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection serviceEndpoints);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool TryParseEndpointsString(string endpointsString, [out] class Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection& serviceEndpoints) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.TryParseEndpointsString(System.String,Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection@)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function TryParseEndpointsString (endpointsString As String, ByRef serviceEndpoints As ServiceEndpointCollection) As Boolean" />
<MemberSignature Language="F#" Value="static member TryParseEndpointsString : string * ServiceEndpointCollection -> bool" Usage="Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection.TryParseEndpointsString (endpointsString, serviceEndpoints)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="endpointsString" Type="System.String" />
<Parameter Name="serviceEndpoints" Type="Microsoft.ServiceFabric.Services.Communication.ServiceEndpointCollection" RefType="out" />
</Parameters>
<Docs>
<param name="endpointsString">string form of endpointsCollection</param>
<param name="serviceEndpoints">ServiceEndpointCollection object if the string can be parsed to a valid ServiceEndpointCollection object</param>
<summary>
Constructs an EndpointsCollection from a string version of the endpoints. String form of EndpointsCollection is of the form
{"Endpoints":{"Listener1":"Endpoint1","Listener2":"Endpoint2" ...}}
</summary>
<returns>True if the string can be parsed to a valid EndpointsCollection, False otherwise</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>