Socket.GetSocketOption 方法

参考

定义

命名空间:: System.Net.Sockets

程序集:: System.Net.Sockets.dll

程序集:: System.dll

程序集:: netstandard.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

返回 Socket 选项的值。

重载

GetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])	返回指定的 Socket 选项设置，表示为字节数组。
GetSocketOption(SocketOptionLevel, SocketOptionName, Int32)	返回数组中指定的 Socket 选项的值。
GetSocketOption(SocketOptionLevel, SocketOptionName)	返回指定的 Socket 选项的值，表示为一个对象。

GetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

Source:: Socket.cs

Source:: Socket.cs

Source:: Socket.cs

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

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

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

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

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

参数

optionLevel: SocketOptionLevel

SocketOptionLevel 值之一。

optionName: SocketOptionName

SocketOptionName 值之一。

optionValue: Byte[]

Byte 类型的数组，用于接收选项设置。

例外

SocketException

尝试访问套接字时出错。

- 或 -

在 .NET Compact Framework 应用程序中，Windows CE 默认缓冲区的空间被设置为 32768 字节。通过调用 SetSocketOption，可以更改每个套接字缓冲区的空间。

ObjectDisposedException

Socket 已关闭。

示例

下面的代码示例检索 LingerOption 和 Send 超时值，并将其显示到控制台。

Console::Write("This application will timeout if Send does not return within ");
Console::WriteLine(Encoding::ASCII->GetString(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::SendTimeout, 4)));

// Blocks until send returns.
int i = s->Send(msg);

// Blocks until read returns.
array<Byte>^ bytes = gcnew array<Byte>(1024);

s->Receive(bytes);

// Displays to the screen.
Console::WriteLine(Encoding::ASCII->GetString(bytes));
s->Shutdown(SocketShutdown::Both);
Console::Write("If data remains to be sent, this application will stay open for ");
Console::WriteLine(safe_cast<LingerOption^>(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::Linger))->LingerTime.ToString());
s->Close();

Console.WriteLine("This application will timeout if Send does not return within " + Encoding.ASCII.GetString(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4)));

// blocks until send returns
int i = s.Send(msg);

// blocks until read returns
byte[] bytes = new byte[1024];

s.Receive(bytes);

// Display to the screen
Console.WriteLine(Encoding.ASCII.GetString(bytes));
s.Shutdown(SocketShutdown.Both);
Console.WriteLine("If data remains to be sent, this application will stay open for " + ((LingerOption)s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger)).LingerTime.ToString());
s.Close();

    Console.WriteLine(("This application will timeout if Send does not return within " + Encoding.ASCII.GetString(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4))))
    ' blocks until send returns
    Dim i As Integer = s.Send(msg)

    ' blocks until read returns
    Dim bytes(1024) As Byte
    s.Receive(bytes)

    'Display to the screen
    Console.WriteLine(Encoding.ASCII.GetString(bytes))
    s.Shutdown(SocketShutdown.Both)

    Console.WriteLine(("If data remains to be sent, this application will stay open for " + CType(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger), LingerOption).LingerTime.ToString()))
    s.Close()
End Sub

注解

Socket 选项确定当前 Socket的行为。成功完成此方法后，由 optionValue 参数指定的数组将包含指定 Socket 选项的值。

当数组的 optionValue 长度小于存储指定 Socket 选项的值所需的字节数时， GetSocketOption 将引发 SocketException。如果收到， SocketException请使用 SocketException.ErrorCode 属性获取特定的错误代码。获取此代码后，请参阅 Windows 套接字版本 2 API 错误代码文档，了解错误的详细说明。将此重载用于由布尔值或整数表示的任何套接字。

备注

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

另请参阅

适用于

GetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

Source:: Socket.cs

Source:: Socket.cs

Source:: Socket.cs

返回数组中指定的 Socket 选项的值。

public:
 cli::array <System::Byte> ^ GetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName, int optionLength);

public byte[] GetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName, int optionLength);

member this.GetSocketOption : System.Net.Sockets.SocketOptionLevel * System.Net.Sockets.SocketOptionName * int -> byte[]

Public Function GetSocketOption (optionLevel As SocketOptionLevel, optionName As SocketOptionName, optionLength As Integer) As Byte()

参数

optionLevel: SocketOptionLevel

SocketOptionLevel 值之一。

optionName: SocketOptionName

SocketOptionName 值之一。

optionLength: Int32

所需返回值的长度（以字节为单位）。

Byte[]

Byte 类型的数组，它包含套接字选项的值。

例外

SocketException

尝试访问套接字时出错。

- 或 -

在 .NET Compact Framework 应用程序中，Windows CE 默认缓冲区的空间被设置为 32768 字节。通过调用 SetSocketOption，可以更改每个套接字缓冲区的空间。

ObjectDisposedException

Socket 已关闭。

示例

下面的代码示例检索 LingerOption 和 Send 超时值，并将其显示到控制台。

Console::Write("This application will timeout if Send does not return within ");
Console::WriteLine(Encoding::ASCII->GetString(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::SendTimeout, 4)));

// Blocks until send returns.
int i = s->Send(msg);

// Blocks until read returns.
array<Byte>^ bytes = gcnew array<Byte>(1024);

s->Receive(bytes);

// Displays to the screen.
Console::WriteLine(Encoding::ASCII->GetString(bytes));
s->Shutdown(SocketShutdown::Both);
Console::Write("If data remains to be sent, this application will stay open for ");
Console::WriteLine(safe_cast<LingerOption^>(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::Linger))->LingerTime.ToString());
s->Close();

Console.WriteLine("This application will timeout if Send does not return within " + Encoding.ASCII.GetString(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4)));

// blocks until send returns
int i = s.Send(msg);

// blocks until read returns
byte[] bytes = new byte[1024];

s.Receive(bytes);

// Display to the screen
Console.WriteLine(Encoding.ASCII.GetString(bytes));
s.Shutdown(SocketShutdown.Both);
Console.WriteLine("If data remains to be sent, this application will stay open for " + ((LingerOption)s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger)).LingerTime.ToString());
s.Close();

    Console.WriteLine(("This application will timeout if Send does not return within " + Encoding.ASCII.GetString(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4))))
    ' blocks until send returns
    Dim i As Integer = s.Send(msg)

    ' blocks until read returns
    Dim bytes(1024) As Byte
    s.Receive(bytes)

    'Display to the screen
    Console.WriteLine(Encoding.ASCII.GetString(bytes))
    s.Shutdown(SocketShutdown.Both)

    Console.WriteLine(("If data remains to be sent, this application will stay open for " + CType(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger), LingerOption).LingerTime.ToString()))
    s.Close()
End Sub

注解

参数 optionLength 设置返回的字节数组的最大大小。如果选项值需要的字节较少，则数组将仅包含那么多字节。如果选项值需要更多字节， GetSocketOption 将引发 SocketException。将此重载用于由布尔值或整数表示的任何套接字。

注意

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

备注

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

另请参阅

适用于

GetSocketOption(SocketOptionLevel, SocketOptionName)

Source:: Socket.cs

Source:: Socket.cs

Source:: Socket.cs

返回指定的 Socket 选项的值，表示为一个对象。

public:
 System::Object ^ GetSocketOption(System::Net::Sockets::SocketOptionLevel optionLevel, System::Net::Sockets::SocketOptionName optionName);

public object? GetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName);

public object GetSocketOption (System.Net.Sockets.SocketOptionLevel optionLevel, System.Net.Sockets.SocketOptionName optionName);

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

Public Function GetSocketOption (optionLevel As SocketOptionLevel, optionName As SocketOptionName) As Object

参数

optionLevel: SocketOptionLevel

SocketOptionLevel 值之一。

optionName: SocketOptionName

SocketOptionName 值之一。

Object

一个对象，表示选项的值。当将 optionName 参数设置为 Linger 时，返回值为 LingerOption 类的一个实例。当将 optionName 设置为 AddMembership 或 DropMembership 时，返回值为 MulticastOption 类的一个实例。当 optionName 为其他任何值时，返回值为整数。

例外

SocketException

尝试访问套接字时出错。

- 或 -

optionName 设置为不支持的值 MaxConnections。

ObjectDisposedException

Socket 已关闭。

示例

下面的代码示例检索 LingerOption 和 Send 超时值，并将其显示到控制台。

Console::Write("This application will timeout if Send does not return within ");
Console::WriteLine(Encoding::ASCII->GetString(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::SendTimeout, 4)));

// Blocks until send returns.
int i = s->Send(msg);

// Blocks until read returns.
array<Byte>^ bytes = gcnew array<Byte>(1024);

s->Receive(bytes);

// Displays to the screen.
Console::WriteLine(Encoding::ASCII->GetString(bytes));
s->Shutdown(SocketShutdown::Both);
Console::Write("If data remains to be sent, this application will stay open for ");
Console::WriteLine(safe_cast<LingerOption^>(s->GetSocketOption(SocketOptionLevel::Socket, SocketOptionName::Linger))->LingerTime.ToString());
s->Close();

Console.WriteLine("This application will timeout if Send does not return within " + Encoding.ASCII.GetString(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4)));

// blocks until send returns
int i = s.Send(msg);

// blocks until read returns
byte[] bytes = new byte[1024];

s.Receive(bytes);

// Display to the screen
Console.WriteLine(Encoding.ASCII.GetString(bytes));
s.Shutdown(SocketShutdown.Both);
Console.WriteLine("If data remains to be sent, this application will stay open for " + ((LingerOption)s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger)).LingerTime.ToString());
s.Close();

    Console.WriteLine(("This application will timeout if Send does not return within " + Encoding.ASCII.GetString(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.SendTimeout, 4))))
    ' blocks until send returns
    Dim i As Integer = s.Send(msg)

    ' blocks until read returns
    Dim bytes(1024) As Byte
    s.Receive(bytes)

    'Display to the screen
    Console.WriteLine(Encoding.ASCII.GetString(bytes))
    s.Shutdown(SocketShutdown.Both)

    Console.WriteLine(("If data remains to be sent, this application will stay open for " + CType(s.GetSocketOption(SocketOptionLevel.Socket, SocketOptionName.Linger), LingerOption).LingerTime.ToString()))
    s.Close()
End Sub

注解

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

注意

备注

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

另请参阅

适用于

通过

Socket.GetSocketOption 方法

定义

重载

GetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

参数

例外

示例

注解

另请参阅

适用于

GetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

参数

返回

例外

示例

注解

另请参阅

适用于

GetSocketOption(SocketOptionLevel, SocketOptionName)

参数

返回

例外

示例

注解

另请参阅

适用于

其他资源