/
ServiceReplicaListener.xml
149 lines (149 loc) · 10.2 KB
/
ServiceReplicaListener.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
<Type Name="ServiceReplicaListener" FullName="Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener">
<TypeSignature Language="C#" Value="public sealed class ServiceReplicaListener" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ServiceReplicaListener extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ServiceReplicaListener" />
<TypeSignature Language="F#" Value="type ServiceReplicaListener = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents the communication listener and its properties for a Stateful Service replica.
Endpoints given out by the communication listener are associated with the name of the communication listener.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ServiceReplicaListener (Func<System.Fabric.StatefulServiceContext,Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener> createCommunicationListener, string name = "", bool listenOnSecondary = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Func`2<class System.Fabric.StatefulServiceContext, class Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener> createCommunicationListener, string name, bool listenOnSecondary) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener.#ctor(System.Func{System.Fabric.StatefulServiceContext,Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener},System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (createCommunicationListener As Func(Of StatefulServiceContext, ICommunicationListener), Optional name As String = "", Optional listenOnSecondary As Boolean = false)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener : Func<System.Fabric.StatefulServiceContext, Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener> * string * bool -> Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener" Usage="new Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener (createCommunicationListener, name, listenOnSecondary)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="createCommunicationListener" Type="System.Func<System.Fabric.StatefulServiceContext,Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener>" />
<Parameter Name="name" Type="System.String" />
<Parameter Name="listenOnSecondary" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="createCommunicationListener">Factory method for creating the communication listener</param>
<param name="name">Name of the communication listener. This parameter is optional, if the service has only one communication listener</param>
<param name="listenOnSecondary">Specifies if the communication listener needs to be opened when the replica becomes Active secondary. THis parameter is optional</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateCommunicationListener">
<MemberSignature Language="C#" Value="public Func<System.Fabric.StatefulServiceContext,Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener> CreateCommunicationListener { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Func`2<class System.Fabric.StatefulServiceContext, class Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener> CreateCommunicationListener" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener.CreateCommunicationListener" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property CreateCommunicationListener As Func(Of StatefulServiceContext, ICommunicationListener)" />
<MemberSignature Language="F#" Value="member this.CreateCommunicationListener : Func<System.Fabric.StatefulServiceContext, Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener>" Usage="Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener.CreateCommunicationListener" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Func<System.Fabric.StatefulServiceContext,Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the factory method for creating the communication listener.
</summary>
<value>To be added.</value>
<remarks>
<para>The factory method takes in a <see cref="T:System.Fabric.StatefulServiceContext" /> and returns communication listener implementing <see cref="T:Microsoft.ServiceFabric.Services.Communication.Runtime.ICommunicationListener" />.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="DefaultName">
<MemberSignature Language="C#" Value="public const string DefaultName;" />
<MemberSignature Language="ILAsm" Value=".field public static literal string DefaultName" />
<MemberSignature Language="DocId" Value="F:Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener.DefaultName" />
<MemberSignature Language="VB.NET" Value="Public Const DefaultName As String " />
<MemberSignature Language="F#" Value="val mutable DefaultName : string" Usage="Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener.DefaultName" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Provides the default name of the service replica listener.
</summary>
<returns>
<see cref="T:System.String" /> value of the name of the default service replica listener.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ListenOnSecondary">
<MemberSignature Language="C#" Value="public bool ListenOnSecondary { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ListenOnSecondary" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener.ListenOnSecondary" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ListenOnSecondary As Boolean" />
<MemberSignature Language="F#" Value="member this.ListenOnSecondary : bool" Usage="Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener.ListenOnSecondary" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a value indicating whether this communication listener should be opened when the replica becomes an
<see cref="F:System.Fabric.ReplicaRole.ActiveSecondary" />.
When this member is false, the communication listener is opened only when the replica becomes
<see cref="F:System.Fabric.ReplicaRole.Primary" />.
The default value for this property is <languageKeyword>false</languageKeyword>.
</summary>
<value>To be added.</value>
<remarks>
This flag can be set when the primary replica is too busy to serve reads and writes efficiently and the application can tolerate reading stale (but consistent) data,
then data can be read from secondary replica.
</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener.Name" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.ServiceFabric.Services.Communication.Runtime.ServiceReplicaListener.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceFabric.Services</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the communication listener.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>