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 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
|
<Type Name="SocketOptionLevel" FullName="System.Net.Sockets.SocketOptionLevel" FullNameSP="System_Net_Sockets_SocketOptionLevel" Maintainer="ecma">
<TypeSignature Language="ILASM" Value=".class public sealed serializable SocketOptionLevel extends System.Enum" />
<TypeSignature Language="C#" Value="public enum SocketOptionLevel" />
<MemberOfLibrary>Networking</MemberOfLibrary>
<AssemblyInfo>
<AssemblyName>System</AssemblyName>
<AssemblyPublicKey>[00 00 00 00 00 00 00 00 04 00 00 00 00 00 00 00 ]</AssemblyPublicKey>
<AssemblyVersion>1.0.x.x</AssemblyVersion>
<AssemblyCulture>none</AssemblyCulture>
<Attributes>
<Attribute>
<AttributeName>CLSCompliantAttribute(true)</AttributeName>
<Excluded>0</Excluded>
</Attribute>
</Attributes>
</AssemblyInfo>
<Docs>
<summary>
<para> Specifies the option level associated with
the <see cref="T:System.Net.Sockets.SocketOptionName" /> used in the <see cref="M:System.Net.Sockets.Socket.SetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName,System.Int32)" /> and <see cref="M:System.Net.Sockets.Socket.GetSocketOption(System.Net.Sockets.SocketOptionLevel,System.Net.Sockets.SocketOptionName)" /> methods
of the <see cref="T:System.Net.Sockets.Socket" /> class.
</para>
</summary>
<remarks>
<para>Some socket options apply only to specific
protocols while others apply to all types. Members of this enumeration specify which protocol applies to
a specific socket option. </para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="value__">
<MemberSignature Language="ILASM" Value=".field public rtspecialname specialname int32 value__" />
<MemberSignature Language="C#" Value="value__;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs />
<Excluded>0</Excluded>
</Member>
<Member MemberName="Socket">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel Socket = 65535" />
<MemberSignature Language="C#" Value="Socket = 65535;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>Socket</MemberValue>
<Docs>
<summary>
<para>Specifies that members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration are not specific to a particular protocol. </para>
<para>The following table lists the members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration used
with this level.</para>
<list type="table">
<listheader>
<term>SocketOptionName</term>
<description>Description</description>
</listheader>
<item>
<term> Broadcast</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates broadcast messages are allowed to be sent to the socket. </description>
</item>
<item>
<term> Debug</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> indicates to record debugging information.</description>
</item>
<item>
<term> DontLinger</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> indicates to close the socket without lingering.</description>
</item>
<item>
<term> DontRoute</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> indicates not to route
data; <see langword="false" /> indicates to send data directly to interface addresses.</description>
</item>
<item>
<term> Error</term>
<description>A
<see cref="T:System.Int32" /> that
contains the error code associated with the last socket error. The error
code is cleared by this option. This option is read-only.</description>
</item>
<item>
<term> KeepAlive</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> (the default) indicates to enable keep-alives, which allows a connection to remain open after a request.</description>
</item>
<item>
<term> OutOfBandInline</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> indicates to receive out-of-band data in the normal data stream.</description>
</item>
<item>
<term> ReceiveBuffer</term>
<description>A <see cref="T:System.Int32" /> that specifies the
total per-socket buffer space reserved for receives. This is unrelated to
the maximum message size or the size of a TCP window.</description>
</item>
<item>
<term> ReceiveTimeout</term>
<description>A
<see cref="T:System.Int32" /> that
specifies the maximum time, in milliseconds, the <see cref="M:System.Net.Sockets.Socket.Receive(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> and <see cref="M:System.Net.Sockets.Socket.ReceiveFrom(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint@)" /> methods will block when attempting to
receive data. If data is not received within this
time, a <see cref="T:System.Net.Sockets.SocketException" /> exception is thrown.</description>
</item>
<item>
<term> ReuseAddress</term>
<description>A <see cref="T:System.Boolean" />
where <see langword="true" /> allows the socket to be bound to an address that is already in use.</description>
</item>
<item>
<term> SendBuffer</term>
<description>A <see cref="T:System.Int32" /> that specifies the total per-socket buffer space reserved for sends. This is unrelated to the maximum message size or the size of a TCP window.</description>
</item>
<item>
<term> SendTimeout</term>
<description>A
<see cref="T:System.Int32" /> that
specifies the maximum time, in milliseconds, the <see cref="M:System.Net.Sockets.Socket.Send(System.Byte[],System.Int32,System.Net.Sockets.SocketFlags)" /> and <see cref="M:System.Net.Sockets.Socket.SendTo(System.Byte[],System.Int32,System.Int32,System.Net.Sockets.SocketFlags,System.Net.EndPoint)" /> methods will block when attempting to
send data. If data is not sent within this time, a <see cref="T:System.Net.Sockets.SocketException" /> exception is thrown.</description>
</item>
<item>
<term> Type</term>
<description>
<para>One of the values defined in the <see cref="T:System.Net.Sockets.SocketType" /> enumeration. This option is
read-only.</para>
</description>
</item>
</list>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="IP">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel IP = 0" />
<MemberSignature Language="C#" Value="IP = 0;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>IP</MemberValue>
<Docs>
<summary>
<para> Specifies that members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration apply to
Internet Protocol (IP).
</para>
<para>The following table lists the members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration used
with this level.</para>
<list type="table">
<listheader>
<term>SocketOptionName</term>
<description>Description of Socket Option Data</description>
</listheader>
<item>
<term> HeaderIncluded</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates
the application is providing the IP header for outgoing
datagrams. </description>
</item>
<item>
<term> IPOptions</term>
<description>A
<see cref="T:System.Byte" /> array
that specifies IP options to be inserted into outgoing
datagrams.</description>
</item>
<item>
<term> IpTimeToLive</term>
<description>A <see cref="T:System.Int32" /> that specifies the
time-to-live for datagrams. The time-to-live designates the number of
networks on which the datagram is allowed to travel
before being discarded by a
router.</description>
</item>
<item>
<term> MulticastInterface</term>
<description>A <see cref="T:System.Byte" qualify="true" />
array that specifies the interface for outgoing multicast
packets.</description>
</item>
<item>
<term> MulticastLoopback</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> enables multicast
loopback. </description>
</item>
<item>
<term> MulticastTimeToLive</term>
<description>A <see cref="T:System.Int32" /> that specifies the
time-to-live for multicast datagrams. </description>
</item>
<item>
<term> TypeOfService</term>
<description>A <see cref="T:System.Int32" /> that specifies the
type of service field in the IP header. </description>
</item>
<item>
<term> UseLoopback</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates Bypass hardware when
possible. </description>
</item>
</list>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Tcp">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel Tcp = 6" />
<MemberSignature Language="C#" Value="Tcp = 6;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>Tcp</MemberValue>
<Docs>
<summary>
<para>Specifies that members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration apply to Transmission Control Protocol (TCP). </para>
<para>The following table lists the members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration used
with this level.</para>
<list type="table">
<listheader>
<term>SocketOptionName</term>
<description>Description of Socket Option Data</description>
</listheader>
<item>
<term> BsdUrgent</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates to use urgent data as defined
by IETF RFC 1222. Once set, this option cannot be turned off.</description>
</item>
<item>
<term> Expedited</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates to use expedited data as defined by IETF RFC 1222.
Once set, this option cannot be turned off.</description>
</item>
<item>
<term> NoDelay</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates to disable the Nagle algorithm for send
coalescing.</description>
</item>
</list>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="Udp">
<MemberSignature Language="ILASM" Value=".field public static literal valuetype System.Net.Sockets.SocketOptionLevel Udp = 17" />
<MemberSignature Language="C#" Value="Udp = 17;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<Parameters />
<MemberValue>Udp</MemberValue>
<Docs>
<summary>
<para>Specifies that members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration apply to User Datagram Protocol
(UDP). </para>
<para>The following table lists the members of the <see cref="T:System.Net.Sockets.SocketOptionName" /> enumeration used
with this level.</para>
<list type="table">
<listheader>
<term>SocketOptionName</term>
<description>Description of Socket Option Data</description>
</listheader>
<item>
<term> ChecksumCoverage</term>
<description>A
<see cref="T:System.Boolean" />
that specifies UDP checksum coverage.</description>
</item>
<item>
<term> NoChecksum</term>
<description>A
<see cref="T:System.Boolean" /> where <see langword="true" /> indicates to send UDP datagrams with the checksum set to zero.</description>
</item>
</list>
</summary>
</Docs>
<Excluded>0</Excluded>
</Member>
<Member MemberName="IPv6">
<MemberSignature Language="C#" Value="public static const System.Net.Sockets.SocketOptionLevel IPv6" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Net.Sockets.SocketOptionLevel</ReturnType>
</ReturnValue>
<MemberValue>IPv6</MemberValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
<TypeExcluded>0</TypeExcluded>
</Type>
|