SocketOptionName Enumeration
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Defines configuration option names.
Namespace: System.Net.Sockets
Assembly: System (in System.dll)
Syntax
'Declaration
Public Enumeration SocketOptionName
public enum SocketOptionName
public enum class SocketOptionName
type SocketOptionName
public enum SocketOptionName
Members
| Member name | Description | |
|---|---|---|
| Debug | Record debugging information. | |
| AcceptConnection | The socket is listening. | |
| ReuseAddress | Allows the socket to be bound to an address that is already in use. | |
| KeepAlive | Use keep-alives. | |
| DontRoute | Do not route; send the packet directly to the interface addresses. | |
| Broadcast | Permit sending broadcast messages on the socket. | |
| UseLoopback | Bypass hardware when possible. | |
| Linger | Linger on close if unsent data is present. | |
| OutOfBandInline | Receives out-of-band data in the normal data stream. | |
| DontLinger | Close the socket gracefully without lingering. | |
| ExclusiveAddressUse | Enables a socket to be bound for exclusive access. | |
| SendBuffer | 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. | |
| ReceiveBuffer | 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. | |
| SendLowWater | Specifies the low water mark for Send operations. | |
| ReceiveLowWater | Specifies the low water mark for Receive operations. | |
| SendTimeout | Send a time-out. This option applies only to synchronous methods; it has no effect on asynchronous methods such as the BeginSend method. | |
| ReceiveTimeout | Receive a time-out. This option applies only to synchronous methods; it has no effect on asynchronous methods such as the BeginSend method. | |
| Error | Get the error status and clear. | |
| Type | Get the socket type. | |
| MaxConnections | Not supported; will throw a SocketException if used. | |
| IPOptions | Specifies the IP options to be inserted into outgoing datagrams. | |
| HeaderIncluded | Indicates that the application provides the IP header for outgoing datagrams. | |
| TypeOfService | Change the IP header type of the service field. | |
| IpTimeToLive | Set the IP header Time-to-Live field. | |
| MulticastInterface | Set the interface for outgoing multicast packets. | |
| MulticastTimeToLive | An IP multicast Time to Live. | |
| MulticastLoopback | An IP multicast loopback. | |
| AddMembership | Add an IP group membership. | |
| DropMembership | Drop an IP group membership. | |
| DontFragment | Do not fragment IP datagrams. | |
| AddSourceMembership | Join a source group. | |
| DropSourceMembership | Drop a source group. | |
| BlockSource | Block data from a source. | |
| UnblockSource | Unblock a previously blocked source. | |
| PacketInformation | Return information about received packets. | |
| HopLimit | Specifies the maximum number of router hops for an Internet Protocol version 6 (IPv6) packet. This is similar to Time to Live (TTL) for Internet Protocol version 4. | |
| NoDelay | Disables the Nagle algorithm for send coalescing. | |
| BsdUrgent | Use urgent data as defined in RFC-1222. This option can be set only once; after it is set, it cannot be turned off. | |
| Expedited | Use expedited data as defined in RFC-1222. This option can be set only once; after it is set, it cannot be turned off. | |
| NoChecksum | Send UDP datagrams with checksum set to zero. | |
| ChecksumCoverage | Set or get the UDP checksum coverage. | |
| UpdateAcceptContext | Updates an accepted socket's properties by using those of an existing socket. This is equivalent to using the Winsock2 SO_UPDATE_ACCEPT_CONTEXT socket option and is supported only on connection-oriented sockets. | |
| UpdateConnectContext | Updates a connected socket's properties by using those of an existing socket. This is equivalent to using the Winsock2 SO_UPDATE_CONNECT_CONTEXT socket option and is supported only on connection-oriented sockets. |
Remarks
The SocketOptionName enumeration defines the name of each Socket configuration option. Sockets can be configured with the Socket..::..SetSocketOption method.