-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
PeerNode.xml
241 lines (229 loc) · 13.8 KB
/
PeerNode.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
<Type Name="PeerNode" FullName="System.ServiceModel.PeerNode">
<TypeSignature Language="C#" Value="public sealed class PeerNode : System.ServiceModel.IOnlineStatus" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit PeerNode extends System.Object implements class System.ServiceModel.IOnlineStatus" />
<TypeSignature Language="DocId" Value="T:System.ServiceModel.PeerNode" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class PeerNode
Implements IOnlineStatus" />
<TypeSignature Language="F#" Value="type PeerNode = class
 interface IOnlineStatus" />
<TypeSignature Language="C++ CLI" Value="public ref class PeerNode sealed : System::ServiceModel::IOnlineStatus" />
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ServiceModel.IOnlineStatus</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Defines the instance of a peer node used by an application participating in a specific peer mesh.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A peer node can host multiple peer channels within the mesh as long as they share a common URI and host name in the <xref:System.ServiceModel.EndpointAddress> supplied to the binding for each channel.
If two or more peer channels defined for a peer node are created with separate bindings, then the <xref:System.ServiceModel.NetPeerTcpBinding.Port%2A>, <xref:System.ServiceModel.NetPeerTcpBinding.ListenIPAddress%2A>, and <xref:System.ServiceModel.NetPeerTcpBinding.Resolver%2A> properties must be identical on all bindings.
If a subsequent channel binding is created after the first one for the same peer node instance, then the <xref:System.ServiceModel.NetPeerTcpBinding.MaxReceivedMessageSize%2A> property on this and subsequent bindings must be less than or equal to the value of <xref:System.ServiceModel.NetPeerTcpBinding.MaxReceivedMessageSize%2A> property as set on the first channel binding.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="IsOnline">
<MemberSignature Language="C#" Value="public bool IsOnline { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsOnline" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.PeerNode.IsOnline" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsOnline As Boolean" />
<MemberSignature Language="F#" Value="member this.IsOnline : bool" Usage="System.ServiceModel.PeerNode.IsOnline" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsOnline { bool get(); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:System.ServiceModel.IOnlineStatus.IsOnline</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the peer node is online and able to send messages to neighboring nodes in the peer mesh.</summary>
<value>
<see langword="true" /> if the peer node is online; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
"Online" indicates that a peer node has available neighbor nodes. "Offline" indicates that a peer node has no available neighbors.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MessagePropagationFilter">
<MemberSignature Language="C#" Value="public System.ServiceModel.PeerMessagePropagationFilter MessagePropagationFilter { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.ServiceModel.PeerMessagePropagationFilter MessagePropagationFilter" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.PeerNode.MessagePropagationFilter" />
<MemberSignature Language="VB.NET" Value="Public Property MessagePropagationFilter As PeerMessagePropagationFilter" />
<MemberSignature Language="F#" Value="member this.MessagePropagationFilter : System.ServiceModel.PeerMessagePropagationFilter with get, set" Usage="System.ServiceModel.PeerNode.MessagePropagationFilter" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::ServiceModel::PeerMessagePropagationFilter ^ MessagePropagationFilter { System::ServiceModel::PeerMessagePropagationFilter ^ get(); void set(System::ServiceModel::PeerMessagePropagationFilter ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ServiceModel.PeerMessagePropagationFilter</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a custom filter for messages received over the peer channel.</summary>
<value>
<see cref="T:System.ServiceModel.PeerMessagePropagationFilter" /> that contains a custom message filter.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The message filter must be a derived type and should be recast to that type to use any custom features defined on it.
]]></format>
</remarks>
<exception cref="T:System.InvalidOperationException">No channel is open for listening.</exception>
</Docs>
</Member>
<Member MemberName="Offline">
<MemberSignature Language="C#" Value="public event EventHandler Offline;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler Offline" />
<MemberSignature Language="DocId" Value="E:System.ServiceModel.PeerNode.Offline" />
<MemberSignature Language="VB.NET" Value="Public Custom Event Offline As EventHandler " FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2" />
<MemberSignature Language="F#" Value="member this.Offline : EventHandler " Usage="member this.Offline : System.EventHandler " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual event EventHandler ^ Offline;" />
<MemberSignature Language="VB.NET" Value="Public Event Offline As EventHandler " FrameworkAlternate="netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<MemberType>Event</MemberType>
<Implements>
<InterfaceMember>E:System.ServiceModel.IOnlineStatus.Offline</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Signals when the peer node goes offline from the peer mesh.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An offline peer node has no neighbor nodes within the peer mesh to which it can connect.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Online">
<MemberSignature Language="C#" Value="public event EventHandler Online;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler Online" />
<MemberSignature Language="DocId" Value="E:System.ServiceModel.PeerNode.Online" />
<MemberSignature Language="VB.NET" Value="Public Custom Event Online As EventHandler " FrameworkAlternate="netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2" />
<MemberSignature Language="F#" Value="member this.Online : EventHandler " Usage="member this.Online : System.EventHandler " />
<MemberSignature Language="C++ CLI" Value="public:
 virtual event EventHandler ^ Online;" />
<MemberSignature Language="VB.NET" Value="Public Event Online As EventHandler " FrameworkAlternate="netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
<MemberType>Event</MemberType>
<Implements>
<InterfaceMember>E:System.ServiceModel.IOnlineStatus.Online</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>Signals when a peer node comes online within the peer mesh.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An online peer node has at least one neighbor node within the peer mesh to which it is connected.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Port">
<MemberSignature Language="C#" Value="public int Port { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Port" />
<MemberSignature Language="DocId" Value="P:System.ServiceModel.PeerNode.Port" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Port As Integer" />
<MemberSignature Language="F#" Value="member this.Port : int" Usage="System.ServiceModel.PeerNode.Port" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Port { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the network port on which the peer node is listening.</summary>
<value>
<see cref="T:System.Int32" /> that specifies the network port on which the peer node is listening.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">No channel is open for listening.</exception>
</Docs>
</Member>
<Member MemberName="RefreshConnection">
<MemberSignature Language="C#" Value="public void RefreshConnection ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RefreshConnection() cil managed" />
<MemberSignature Language="DocId" Value="M:System.ServiceModel.PeerNode.RefreshConnection" />
<MemberSignature Language="VB.NET" Value="Public Sub RefreshConnection ()" />
<MemberSignature Language="F#" Value="member this.RefreshConnection : unit -> unit" Usage="peerNode.RefreshConnection " />
<MemberSignature Language="C++ CLI" Value="public:
 void RefreshConnection();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Refreshes the connection with the peer mesh.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">No channel is open for listening.</exception>
<exception cref="T:System.TimeoutException">The refresh operation timed out.</exception>
<exception cref="T:System.ServiceModel.CommunicationException">A network error occurred during the refresh attempt.</exception>
<exception cref="T:System.ServiceModel.CommunicationObjectAbortedException">The connection aborted during the refresh attempt.</exception>
<exception cref="T:System.ServiceModel.CommunicationObjectFaultedException">The connection faulted during the refresh attempt.</exception>
</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:System.ServiceModel.PeerNode.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="peerNode.ToString " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ ToString();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.ServiceModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Provides a string representation of a peer node.</summary>
<returns>
<see cref="T:System.String" /> value that contains the mesh ID of the peer node if the mesh ID is set; otherwise, it returns the type.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>