Freigeben über


Socket.SetSocketOption Methode

Definition

Legt eine Socket Option fest.

Überlädt

Name Beschreibung
SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean)

Legt die angegebene Socket Option auf den angegebenen Boolean Wert fest.

SetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

Legt die angegebene Socket Option auf den angegebenen Wert fest, dargestellt als Bytearray.

SetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

Legt die angegebene Socket Option auf den angegebenen ganzzahligen Wert fest.

SetSocketOption(SocketOptionLevel, SocketOptionName, Object)

Legt die angegebene Socket Option auf den angegebenen Wert fest, dargestellt als Objekt.

SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean)

Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs

Legt die angegebene Socket Option auf den angegebenen Boolean Wert fest.

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)

Parameter

optionLevel
SocketOptionLevel

Einer der SocketOptionLevel Werte.

optionName
SocketOptionName

Einer der SocketOptionName Werte.

optionValue
Boolean

Der Wert der Option, dargestellt als ein Boolean.

Ausnahmen

Das Socket Objekt wurde geschlossen.

Beim Versuch, auf den Socket zuzugreifen, ist ein Fehler aufgetreten.

Beispiele

Im folgenden Codebeispiel wird ein Socket geöffnet und die DontLingerOutOfBandInline Socketoptionen aktiviert.

// 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);

Hinweise

Socket options determine the behavior of the current Socket. Legen Sie diese optionValue Option fest true , um die Option zu aktivieren oder die Option zu false deaktivieren.

Socket Optionen werden nach Protokollunterstützungsebene gruppiert.

Nachfolgend sind die verschiedenen Socket Optionen aufgeführt, die mithilfe dieser Überladung festgelegt werden können. Diese Optionen werden nach dem entsprechenden SocketOptionLevel Wert gruppiert. Wenn Sie eine dieser Optionen festlegen möchten, müssen Sie unbedingt den entsprechenden SocketOptionLevel Wert für den optionLevel Parameter verwenden. Die Option, die optionName Sie festlegen möchten, muss im Parameter angegeben werden. Wenn Sie den aktuellen Wert einer der aufgelisteten Optionen abrufen möchten, verwenden Sie die GetSocketOption Methode.

SocketOptionLevel.Socket Optionen, die mithilfe dieser Überladung festgelegt werden können.

SocketOptionLevel.IP Optionen, die mithilfe dieser Überladung festgelegt werden können.

SocketOptionLevel.Tcp Optionen, die mithilfe dieser Überladung festgelegt werden können.

SocketOptionLevel.Udp Optionen, die mithilfe dieser Überladung festgelegt werden können.

Weitere Informationen zu diesen Optionen finden Sie in der SocketOptionName Enumeration.

Hinweis

Wenn Sie eine SocketException Ausnahme erhalten, verwenden Sie die SocketException.ErrorCode Eigenschaft, um den spezifischen Fehlercode abzurufen. Nachdem Sie diesen Code erhalten haben, finden Sie in der Windows Sockets Version 2-API-Fehlercodedokumentation eine detaillierte Beschreibung des Fehlers.

Gilt für:

SetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs

Legt die angegebene Socket Option auf den angegebenen Wert fest, dargestellt als Bytearray.

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())

Parameter

optionLevel
SocketOptionLevel

Einer der SocketOptionLevel Werte.

optionName
SocketOptionName

Einer der SocketOptionName Werte.

optionValue
Byte[]

Ein Array vom Typ Byte , das den Wert der Option darstellt.

Ausnahmen

Beim Versuch, auf den Socket zuzugreifen, ist ein Fehler aufgetreten.

Das Socket wurde geschlossen.

Beispiele

Im folgenden Codebeispiel werden die LingerOption Werte und Send Timeoutwerte festgelegt.

// 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)

Hinweise

Socket options determine the behavior of the current Socket. Verwenden Sie diese Überladung, um diese Socket Optionen festzulegen, die ein Bytearray als Optionswert erfordern.

Hinweis

Wenn Sie ein SocketExceptionObjekt erhalten, verwenden Sie die SocketException.ErrorCode Eigenschaft, um den spezifischen Fehlercode abzurufen. Nachdem Sie diesen Code erhalten haben, finden Sie in der Windows Sockets Version 2-API-Fehlercodedokumentation eine detaillierte Beschreibung des Fehlers.

Hinweis

Dieses Mitglied gibt Protokollierungsinformationen aus, wenn Sie die Netzwerkablaufverfolgung in Ihrer Anwendung aktivieren. Weitere Informationen finden Sie unter Network Tracing in .NET Framework.

Weitere Informationen

Gilt für:

SetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs

Legt die angegebene Socket Option auf den angegebenen ganzzahligen Wert fest.

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)

Parameter

optionLevel
SocketOptionLevel

Einer der SocketOptionLevel Werte.

optionName
SocketOptionName

Einer der SocketOptionName Werte.

optionValue
Int32

Ein Wert der Option.

Ausnahmen

Beim Versuch, auf den Socket zuzugreifen, ist ein Fehler aufgetreten.

Das Socket wurde geschlossen.

Beispiele

Im folgenden Codebeispiel werden die LingerOption Werte und Send Timeoutwerte festgelegt.

// 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)

Hinweise

Socket options determine the behavior of the current Socket. Geben Sie für eine Option mit einem Boolean Datentyp einen Wert ungleich Null an, um die Option zu aktivieren, und einen Nullwert, um die Option zu deaktivieren. Geben Sie für eine Option mit einem ganzzahligen Datentyp den entsprechenden Wert an. Socket Optionen werden nach Protokollunterstützungsebene gruppiert.

Nachfolgend sind die verschiedenen Socket Optionen aufgeführt, die mithilfe dieser Überladung festgelegt werden können. Diese Optionen werden nach den entsprechenden SocketOptionLeveloptionen gruppiert. Wenn Sie eine dieser Optionen festlegen möchten, stellen Sie sicher, dass Sie den für den optionLevel Parameter geeigneten SocketOptionLevel Parameter verwenden. Die Option, die optionName Sie festlegen möchten, muss im Parameter angegeben werden. Wenn Sie den aktuellen Wert einer der aufgelisteten Optionen abrufen möchten, verwenden Sie die GetSocketOption Methode.

SocketOptionLevel.Socket Optionen, die mithilfe dieser Überladung festgelegt werden können.

SocketOptionLevel.IP Optionen, die mithilfe dieser Überladung festgelegt werden können.

SocketOptionLevel.Tcp Optionen, die mithilfe dieser Überladung festgelegt werden können.

SocketOptionLevel.Udp Optionen, die mithilfe dieser Überladung festgelegt werden können.

SocketOptionLevel.IPv6 Optionen, die mithilfe dieser Überladung festgelegt werden können.

Weitere Informationen zu diesen Optionen finden Sie in der SocketOptionName Enumeration.

Hinweis

Wenn Sie ein SocketExceptionObjekt erhalten, verwenden Sie die SocketException.ErrorCode Eigenschaft, um den spezifischen Fehlercode abzurufen. Nachdem Sie diesen Code erhalten haben, finden Sie in der Windows Sockets Version 2-API-Fehlercodedokumentation eine detaillierte Beschreibung des Fehlers.

Hinweis

Dieses Mitglied gibt Protokollierungsinformationen aus, wenn Sie die Netzwerkablaufverfolgung in Ihrer Anwendung aktivieren. Weitere Informationen finden Sie unter Network Tracing in .NET Framework.

Weitere Informationen

Gilt für:

SetSocketOption(SocketOptionLevel, SocketOptionName, Object)

Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs
Quelle:
Socket.cs

Legt die angegebene Socket Option auf den angegebenen Wert fest, dargestellt als Objekt.

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)

Parameter

optionLevel
SocketOptionLevel

Einer der SocketOptionLevel Werte.

optionName
SocketOptionName

Einer der SocketOptionName Werte.

optionValue
Object

A LingerOption oder MulticastOption der den Wert der Option enthält.

Ausnahmen

optionValue ist null.

Beim Versuch, auf den Socket zuzugreifen, ist ein Fehler aufgetreten.

Das Socket wurde geschlossen.

Beispiele

Im folgenden Codebeispiel werden die LingerOption Werte und Send Timeoutwerte festgelegt.

// 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)

Hinweise

Socket options determine the behavior of the current Socket. Verwenden Sie diese Überladung, um die LingerOptionen AddMembershipund DropMembershipSocket Optionen festzulegen. Verwenden Sie Linger für die Socket Option den optionLevel Parameter. Für AddMembership und DropMembership, verwenden IPSie . Wenn Sie den aktuellen Wert einer der oben aufgeführten Optionen abrufen möchten, verwenden Sie die GetSocketOption Methode.

Hinweis

Wenn Sie ein SocketExceptionObjekt erhalten, verwenden Sie die SocketException.ErrorCode Eigenschaft, um den spezifischen Fehlercode abzurufen. Nachdem Sie diesen Code erhalten haben, finden Sie in der Windows Sockets Version 2-API-Fehlercodedokumentation eine detaillierte Beschreibung des Fehlers.

Weitere Informationen

Gilt für: