SocketOptionName Enumeration

SocketOptionName Enumeration

 

Defines configuration option names.

Namespace:   System.Net.Sockets
Assembly:  System (in System.dll)

public enum SocketOptionName

Member nameDescription
AcceptConnection

The socket is listening.

AddMembership

Add an IP group membership.

AddSourceMembership

Join a source group.

BlockSource

Block data from a source.

Broadcast

Permit sending broadcast messages on the socket.

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.

ChecksumCoverage

Set or get the UDP checksum coverage.

Debug

Record debugging information.

DontFragment

Do not fragment IP datagrams.

DontLinger

Close the socket gracefully without lingering.

DontRoute

Do not route; send the packet directly to the interface addresses.

DropMembership

Drop an IP group membership.

DropSourceMembership

Drop a source group.

Error

Get the error status and clear.

ExclusiveAddressUse

Enables a socket to be bound for exclusive access.

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.

HeaderIncluded

Indicates that the application provides the IP header for outgoing datagrams.

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.

IPOptions

Specifies the IP options to be inserted into outgoing datagrams.

IPProtectionLevel

Enables restriction of a IPv6 socket to a specified scope, such as addresses with the same link local or site local prefix.This socket 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 socket 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 socket option has defined protection levels specified in the IPProtectionLevel enumeration.

IpTimeToLive

Set the IP header Time-to-Live field.

IPv6Only

Indicates if a socket created for the AF_INET6 address family is restricted to IPv6 communications only. Sockets created for the AF_INET6 address family may be used for both IPv6 and IPv4 communications. Some applications may want to restrict their use of a socket created for the AF_INET6 address family to IPv6 communications only. When this value is non-zero (the default on Windows), a socket created for the AF_INET6 address family can be used to send and receive IPv6 packets only. When this value is zero, a socket created for the AF_INET6 address family can be used to send and receive packets to and from an IPv6 address or an IPv4 address. Note that the ability to interact with an IPv4 address requires the use of IPv4 mapped addresses. This socket option is supported on Windows Vista or later.

KeepAlive

Use keep-alives.

Linger

Linger on close if unsent data is present.

MaxConnections

Not supported; will throw a SocketException if used.

MulticastInterface

Set the interface for outgoing multicast packets.

MulticastLoopback

An IP multicast loopback.

MulticastTimeToLive

An IP multicast Time to Live.

NoChecksum

Send UDP datagrams with checksum set to zero.

NoDelay

Disables the Nagle algorithm for send coalescing.

OutOfBandInline

Receives out-of-band data in the normal data stream.

PacketInformation

Return information about received packets.

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.

ReceiveLowWater

Specifies the low water mark for Receive operations.

ReceiveTimeout

Receive a time-out. This option applies only to synchronous methods; it has no effect on asynchronous methods such as the BeginSend method.

ReuseAddress

Allows the socket to be bound to an address that is already in use.

ReuseUnicastPort

Indicates that the system should defer ephemeral port allocation for outbound connections. This is equivalent to using the Winsock2 SO_REUSE_UNICASTPORT socket option.

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.

SendLowWater

Specifies the low water mark for Send 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.

Type

Get the socket type.

TypeOfService

Change the IP header type of the service field.

UnblockSource

Unblock a previously blocked source.

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.

UseLoopback

Bypass hardware when possible.

The SocketOptionName enumeration defines the name of each Socket configuration option. Sockets can be configured with the Socket.SetSocketOption method.

The following code example uses this enumeration to set socket options.

// Send operations will time-out if confirmation 
// is not received within 1000 milliseconds.
s.SetSocketOption (SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 1000);

// The socket will linger for 10 seconds after Socket.Close is called.
LingerOption lingerOption = new LingerOption (true, 10);

s.SetSocketOption (SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption);

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft