/
SocketElement.xml
211 lines (203 loc) · 14.3 KB
/
SocketElement.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
<Type Name="SocketElement" FullName="System.Net.Configuration.SocketElement">
<TypeSignature Language="C#" Value="public sealed class SocketElement : System.Configuration.ConfigurationElement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SocketElement extends System.Configuration.ConfigurationElement" />
<TypeSignature Language="DocId" Value="T:System.Net.Configuration.SocketElement" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SocketElement
Inherits ConfigurationElement" />
<TypeSignature Language="F#" Value="type SocketElement = class
 inherit ConfigurationElement" />
<TypeSignature Language="C++ CLI" Value="public ref class SocketElement sealed : System::Configuration::ConfigurationElement" />
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.ConfigurationElement</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents information used to configure <see cref="T:System.Net.Sockets.Socket" /> objects. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown">< configuration element.
This class provides programmatic access to information that can be stored in configuration files.
This class is used to specify whether completion ports are used for connecting, whether completion ports are used for accepting connections, and the default IP protection level for an IPv6 socket.
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/">Network Settings Schema</related>
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/socket-element-network-settings">Socket Element (Network Settings)</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SocketElement ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Configuration.SocketElement.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SocketElement();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Net.Configuration.SocketElement" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor adds the <xref:System.Net.Configuration.SocketElement.AlwaysUseCompletionPortsForAccept%2A> and <xref:System.Net.Configuration.ConnectionManagementElement.MaxConnection%2A> properties to the <xref:System.Net.Configuration.SocketElement.AlwaysUseCompletionPortsForAccept%2A> collection.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AlwaysUseCompletionPortsForAccept">
<MemberSignature Language="C#" Value="public bool AlwaysUseCompletionPortsForAccept { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AlwaysUseCompletionPortsForAccept" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.SocketElement.AlwaysUseCompletionPortsForAccept" />
<MemberSignature Language="VB.NET" Value="Public Property AlwaysUseCompletionPortsForAccept As Boolean" />
<MemberSignature Language="F#" Value="member this.AlwaysUseCompletionPortsForAccept : bool with get, set" Usage="System.Net.Configuration.SocketElement.AlwaysUseCompletionPortsForAccept" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool AlwaysUseCompletionPortsForAccept { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("alwaysUseCompletionPortsForAccept", DefaultValue=false)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("alwaysUseCompletionPortsForAccept", DefaultValue=false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a Boolean value that specifies whether completion ports are used when accepting connections.</summary>
<value>
<see langword="true" /> to use completion ports; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/">Network Settings Schema</related>
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/socket-element-network-settings"><socket> Element (Network Settings)</related>
</Docs>
</Member>
<Member MemberName="AlwaysUseCompletionPortsForConnect">
<MemberSignature Language="C#" Value="public bool AlwaysUseCompletionPortsForConnect { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool AlwaysUseCompletionPortsForConnect" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.SocketElement.AlwaysUseCompletionPortsForConnect" />
<MemberSignature Language="VB.NET" Value="Public Property AlwaysUseCompletionPortsForConnect As Boolean" />
<MemberSignature Language="F#" Value="member this.AlwaysUseCompletionPortsForConnect : bool with get, set" Usage="System.Net.Configuration.SocketElement.AlwaysUseCompletionPortsForConnect" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool AlwaysUseCompletionPortsForConnect { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("alwaysUseCompletionPortsForConnect", DefaultValue=false)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("alwaysUseCompletionPortsForConnect", DefaultValue=false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a Boolean value that specifies whether completion ports are used when making connections.</summary>
<value>
<see langword="true" /> to use completion ports; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/">Network Settings Schema</related>
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/socket-element-network-settings"><socket> Element (Network Settings)</related>
</Docs>
</Member>
<Member MemberName="IPProtectionLevel">
<MemberSignature Language="C#" Value="public System.Net.Sockets.IPProtectionLevel IPProtectionLevel { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Net.Sockets.IPProtectionLevel IPProtectionLevel" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.SocketElement.IPProtectionLevel" />
<MemberSignature Language="VB.NET" Value="Public Property IPProtectionLevel As IPProtectionLevel" />
<MemberSignature Language="F#" Value="member this.IPProtectionLevel : System.Net.Sockets.IPProtectionLevel with get, set" Usage="System.Net.Configuration.SocketElement.IPProtectionLevel" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Net::Sockets::IPProtectionLevel IPProtectionLevel { System::Net::Sockets::IPProtectionLevel get(); void set(System::Net::Sockets::IPProtectionLevel value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;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">
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("ipProtectionLevel", DefaultValue=System.Net.Sockets.IPProtectionLevel.Unspecified)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("ipProtectionLevel", DefaultValue=System.Net.Sockets.IPProtectionLevel.Unspecified)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Net.Sockets.IPProtectionLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that specifies the default <see cref="T:System.Net.Sockets.IPProtectionLevel" /> to use for a socket.</summary>
<value>The value of the <see cref="T:System.Net.Sockets.IPProtectionLevel" /> for the current instance.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Net.Configuration.SocketElement.IPProtectionLevel%2A> property enables configuration of a restriction for an IPv6 socket to a specified scope, such as addresses with the same link local or site local prefix. This option enables applications to place access restrictions on IPv6 sockets. Such restrictions enable an application running on a private LAN to simply and robustly harden itself against external attacks. This option widens or narrows the scope of a listening socket, enabling unrestricted access from public and private users when appropriate, or restricting access only to the same site, as required. This option has three defined protection levels specified in the <xref:System.Net.Sockets.IPProtectionLevel?displayProperty=nameWithType> enumeration.
]]></format>
</remarks>
<altmember cref="T:System.Net.Sockets.IPProtectionLevel" />
<altmember cref="F:System.Net.Sockets.SocketOptionName.IPProtectionLevel" />
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/">Network Settings Schema</related>
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/network/socket-element-network-settings"><socket> Element (Network Settings)</related>
</Docs>
</Member>
<Member MemberName="PostDeserialize">
<MemberSignature Language="C#" Value="protected override void PostDeserialize ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void PostDeserialize() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Configuration.SocketElement.PostDeserialize" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub PostDeserialize ()" />
<MemberSignature Language="F#" Value="override this.PostDeserialize : unit -> unit" Usage="socketElement.PostDeserialize " />
<MemberSignature Language="C++ CLI" Value="protected:
 override void PostDeserialize();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.ConfigurationPropertyCollection Properties" />
<MemberSignature Language="DocId" Value="P:System.Net.Configuration.SocketElement.Properties" />
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property Properties As ConfigurationPropertyCollection" />
<MemberSignature Language="F#" Value="member this.Properties : System.Configuration.ConfigurationPropertyCollection" Usage="System.Net.Configuration.SocketElement.Properties" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Configuration::ConfigurationPropertyCollection ^ Properties { System::Configuration::ConfigurationPropertyCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>