Socket.SetSocketOption 方法

定义

命名空间:

System.Net.Sockets

程序集:

netstandard.dll, System.Net.Sockets.dll

设置选项 Socket 。

重载

名称	说明
SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean)	将指定的 Socket 选项设置为指定的 Boolean 值。
SetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])	将指定的 Socket 选项设置为指定值，表示为字节数组。
SetSocketOption(SocketOptionLevel, SocketOptionName, Int32)	将指定的 Socket 选项设置为指定的整数值。
SetSocketOption(SocketOptionLevel, SocketOptionName, Object)	将指定 Socket 选项设置为指定值，表示为对象。

SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean)

Source:

Socket.cs

将指定的 Socket 选项设置为指定的 Boolean 值。

public:
 void SetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, bool optionValue);

public void SetSocketOption(System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, bool optionValue);

member this.SetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * bool -> unit

Public Sub SetSocketOption (optionLevel As SocketOptionLevel, optionName As SocketOptionName, optionValue As Boolean)

参数

optionLevel

SocketOptionLevel

其中一个 SocketOptionLevel 值。

optionName

SocketOptionName

其中一个 SocketOptionName 值。

optionValue

Boolean

选项的值，表示为 .Boolean

例外

ObjectDisposedException

对象 Socket 已关闭。

SocketException

尝试访问套接字时出错。

示例

下面的代码示例打开套接字并启用DontLingerOutOfBandInline套接字选项。

// Establish the local endpoint for the socket.
IPHostEntry ipHost = Dns.GetHostEntry(Dns.GetHostName());
IPAddress  ipAddr = ipHost.AddressList[0];
IPEndPoint ipEndPoint = new IPEndPoint(ipAddr, 11000);

// Create a TCP socket.
Socket client = new Socket(AddressFamily.InterNetwork,
    SocketType.Stream, ProtocolType.Tcp);

// Connect the socket to the remote endpoint.
client.Connect(ipEndPoint);

// Set option that allows socket to close gracefully without lingering.
client.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.DontLinger, true);

// Set option that allows socket to receive out-of-band information in the data stream.
client.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.OutOfBandInline, true);

注解

Socket 选项确定当前 Socket的行为。 true设置为optionValue启用该选项或禁用false该选项。

Socket 选项按协议支持级别进行分组。

下面列出了可以使用此重载设置的各种 Socket 选项。 这些选项按相应的 SocketOptionLevel 值进行分组。 如果打算设置其中任一选项，请确保对optionLevel参数使用适当的SocketOptionLevel值。 选择设置的选项必须在参数中 optionName 指定。 如果要获取列出的任一选项的当前值，请使用 GetSocketOption 该方法。

SocketOptionLevel.Socket 可以使用此重载设置的选项。

• AcceptConnection

• Broadcast

• DontLinger

• Debug

• KeepAlive

• OutOfBandInline

• ReuseAddress

SocketOptionLevel.IP 可以使用此重载设置的选项。

• HeaderIncluded

• MulticastLoopback

• UseLoopback

SocketOptionLevel.Tcp 可以使用此重载设置的选项。

• BsdUrgent

• Expedited

• NoDelay

SocketOptionLevel.Udp 可以使用此重载设置的选项。

• NoChecksum

有关这些选项的详细信息，请参阅 SocketOptionName 枚举。

注释

如果收到 SocketException 异常，请使用 SocketException.ErrorCode 该属性获取特定的错误代码。 获取此代码后，有关错误的详细说明，请参阅 Windows 套接字版本 2 API 错误代码 文档。

SetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

Source:

Socket.cs

将指定的 Socket 选项设置为指定值，表示为字节数组。

public:
 void SetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, cli::array <System::Byte> ^ optionValue);

public void SetSocketOption(System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, byte[] optionValue);

member this.SetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * byte[] -> unit

Public Sub SetSocketOption (optionLevel As SocketOptionLevel, optionName As SocketOptionName, optionValue As Byte())

参数

optionLevel

SocketOptionLevel

其中一个 SocketOptionLevel 值。

optionName

SocketOptionName

其中一个 SocketOptionName 值。

optionValue

Byte[]

一个类型 Byte 数组，表示选项的值。

例外

SocketException

尝试访问套接字时出错。

ObjectDisposedException

Socket已关闭。

示例

下面的代码示例设置LingerOption超时值。Send

// The socket will linger for 10 seconds after Socket.Close is called.
var lingerOption = new LingerOption(true, 10);
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption);

' The socket will linger for 10 seconds after Socket.Close is called.
Dim lingerOption As New LingerOption(True, 10)
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption)

注解

Socket 选项确定当前 Socket的行为。 使用此重载可将需要字节数组的选项设置为 Socket 选项值。

注释

如果收到， SocketException请使用该 SocketException.ErrorCode 属性获取特定的错误代码。 获取此代码后，有关错误的详细说明，请参阅 Windows 套接字版本 2 API 错误代码 文档。

注释

在应用程序中启用网络跟踪时，此成员将输出跟踪信息。 有关详细信息，请参阅 .NET Framework 中的网络跟踪。

另请参阅

• SocketOptionName
• SocketOptionLevel
• GetSocketOption(SocketOptionLevel, SocketOptionName)

SetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

Source:

Socket.cs

将指定的 Socket 选项设置为指定的整数值。

public:
 void SetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, int optionValue);

public void SetSocketOption(System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, int optionValue);

member this.SetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * int -> unit

Public Sub SetSocketOption (optionLevel As SocketOptionLevel, optionName As SocketOptionName, optionValue As Integer)

参数

optionLevel

SocketOptionLevel

其中一个 SocketOptionLevel 值。

optionName

SocketOptionName

其中一个 SocketOptionName 值。

optionValue

Int32

选项的值。

例外

SocketException

尝试访问套接字时出错。

ObjectDisposedException

Socket已关闭。

示例

下面的代码示例设置LingerOption超时值。Send

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

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

注解

Socket 选项确定当前 Socket的行为。 对于数据类型 Boolean 为选项，请指定一个非零值以启用该选项，并指定一个零值以禁用该选项。 对于具有整数数据类型的选项，请指定适当的值。 Socket 选项按协议支持级别进行分组。

下面列出了可以使用此重载设置的各种 Socket 选项。 这些选项按相应的 SocketOptionLevel分组方式进行分组。 如果打算设置这些选项中的任何一个，请务必对optionLevel参数使用适当的SocketOptionLevel选项。 选择设置的选项必须在参数中 optionName 指定。 如果要获取列出的任一选项的当前值，请使用 GetSocketOption 该方法。

SocketOptionLevel.Socket 可以使用此重载设置的选项。

• Broadcast

• DontLinger

• Debug

• Error

• KeepAlive

• OutOfBandInline

• ReceiveBuffer

• ReceiveTimeout

• ReuseAddress

• SendBuffer

• SendTimeout

• Type

SocketOptionLevel.IP 可以使用此重载设置的选项。

• HeaderIncluded

• IPOptions

• IpTimeToLive

• MulticastInterface

• MulticastLoopback

• MulticastTimeToLive

• TypeOfService

• UseLoopback

SocketOptionLevel.Tcp 可以使用此重载设置的选项。

• BsdUrgent

• Expedited

• NoDelay

SocketOptionLevel.Udp 可以使用此重载设置的选项。

• ChecksumCoverage

• NoChecksum

SocketOptionLevel.IPv6 可以使用此重载设置的选项。

• HopLimit

有关这些选项的详细信息，请参阅 SocketOptionName 枚举。

注释

如果收到， SocketException请使用该 SocketException.ErrorCode 属性获取特定的错误代码。 获取此代码后，有关错误的详细说明，请参阅 Windows 套接字版本 2 API 错误代码 文档。

注释

在应用程序中启用网络跟踪时，此成员将输出跟踪信息。 有关详细信息，请参阅 .NET Framework 中的网络跟踪。

另请参阅

• SocketOptionName
• SocketOptionLevel
• GetSocketOption(SocketOptionLevel, SocketOptionName)

SetSocketOption(SocketOptionLevel, SocketOptionName, Object)

Source:

Socket.cs

将指定 Socket 选项设置为指定值，表示为对象。

public:
 void SetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, System::Object ^ optionValue);

public void SetSocketOption(System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, object optionValue);

member this.SetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * obj -> unit

Public Sub SetSocketOption (optionLevel As SocketOptionLevel, optionName As SocketOptionName, optionValue As Object)

参数

optionLevel

SocketOptionLevel

其中一个 SocketOptionLevel 值。

optionName

SocketOptionName

其中一个 SocketOptionName 值。

optionValue

Object

一个 LingerOption 或 MulticastOption 包含选项的值。

例外

ArgumentNullException

optionValue 是 null。

SocketException

尝试访问套接字时出错。

ObjectDisposedException

Socket已关闭。

示例

下面的代码示例设置 LingerOption 和 Send 超时值。

// The socket will linger for 10 seconds after Socket.Close is called.
var lingerOption = new LingerOption(true, 10);
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption);

' The socket will linger for 10 seconds after Socket.Close is called.
Dim lingerOption As New LingerOption(True, 10)
s.SetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger, lingerOption)

注解

Socket 选项确定当前 Socket的行为。 使用此重载设置Linger和AddMembershipDropMembershipSocket选项。 Linger对于选项，请Socket用于optionLevel参数。 对于 AddMembership 和 DropMembership，请使用 IP。 如果要获取上面列出的任一选项的当前值，请使用 GetSocketOption 该方法。

注释

如果收到， SocketException请使用该 SocketException.ErrorCode 属性获取特定的错误代码。 获取此代码后，有关错误的详细说明，请参阅 Windows 套接字版本 2 API 错误代码 文档。

另请参阅

• SocketOptionName
• SocketOptionLevel
• GetSocketOption(SocketOptionLevel, SocketOptionName)