Socket.SetSocketOption Méthode

Définition

Espace de noms:

System.Net.Sockets

Assemblys:

netstandard.dll, System.Net.Sockets.dll

Définit une Socket option.

Surcharges

Nom	Description
SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean)	Définit l’option spécifiée Socket sur la valeur spécifiée Boolean .
SetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])	Définit l’option spécifiée Socket sur la valeur spécifiée, représentée sous la forme d’un tableau d’octets.
SetSocketOption(SocketOptionLevel, SocketOptionName, Int32)	Définit l’option spécifiée Socket sur la valeur entière spécifiée.
SetSocketOption(SocketOptionLevel, SocketOptionName, Object)	Définit l’option spécifiée Socket sur la valeur spécifiée, représentée en tant qu’objet.

SetSocketOption(SocketOptionLevel, SocketOptionName, Boolean)

Source:

Socket.cs

Définit l’option spécifiée Socket sur la valeur spécifiée 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)

Paramètres

optionLevel

SocketOptionLevel

Une des SocketOptionLevel valeurs.

optionName

SocketOptionName

Une des SocketOptionName valeurs.

optionValue

Boolean

Valeur de l’option, représentée en tant que Boolean.

Exceptions

ObjectDisposedException

L’objet Socket a été fermé.

SocketException

Une erreur s’est produite lors de la tentative d’accès au socket.

Exemples

L’exemple de code suivant ouvre un socket et active les DontLinger options de socket et de OutOfBandInline socket.

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

Remarques

Socket les options déterminent le comportement du actif Socket. Définissez optionValue la valeur pour true activer l’option ou pour false désactiver l’option.

Socket les options sont regroupées par niveau de prise en charge du protocole.

Vous trouverez ci-dessous les différentes Socket options qui peuvent être définies à l’aide de cette surcharge. Ces options sont regroupées par la valeur appropriée SocketOptionLevel . Si vous envisagez de définir l’une de ces options, veillez à utiliser la valeur appropriée SocketOptionLevel pour le optionLevel paramètre. L’option que vous choisissez de définir doit être spécifiée dans le optionName paramètre. Si vous souhaitez obtenir la valeur actuelle de l’une des options répertoriées, utilisez la GetSocketOption méthode.

SocketOptionLevel.Socket options qui peuvent être définies à l’aide de cette surcharge.

• AcceptConnection

• Broadcast

• DontLinger

• Debug

• KeepAlive

• OutOfBandInline

• ReuseAddress

SocketOptionLevel.IP options qui peuvent être définies à l’aide de cette surcharge.

• HeaderIncluded

• MulticastLoopback

• UseLoopback

SocketOptionLevel.Tcp options qui peuvent être définies à l’aide de cette surcharge.

• BsdUrgent

• Expedited

• NoDelay

SocketOptionLevel.Udp options qui peuvent être définies à l’aide de cette surcharge.

• NoChecksum

Pour plus d’informations sur ces options, reportez-vous à l’énumération SocketOptionName .

Note

Si vous recevez une SocketException exception, utilisez la SocketException.ErrorCode propriété pour obtenir le code d’erreur spécifique. Une fois que vous avez obtenu ce code, reportez-vous à la documentation du code d’erreur de l’API Windows Sockets version 2 pour obtenir une description détaillée de l’erreur.

SetSocketOption(SocketOptionLevel, SocketOptionName, Byte[])

Source:

Socket.cs

Définit l’option spécifiée Socket sur la valeur spécifiée, représentée sous la forme d’un tableau d’octets.

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

Paramètres

optionLevel

SocketOptionLevel

Une des SocketOptionLevel valeurs.

optionName

SocketOptionName

Une des SocketOptionName valeurs.

optionValue

Byte[]

Tableau de type Byte qui représente la valeur de l’option.

Exceptions

SocketException

Une erreur s’est produite lors de la tentative d’accès au socket.

ObjectDisposedException

Il Socket a été fermé.

Exemples

L’exemple de code suivant définit les LingerOption valeurs et Send le délai d’attente.

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

Remarques

Socket les options déterminent le comportement du actif Socket. Utilisez cette surcharge pour définir ces Socket options qui nécessitent un tableau d’octets comme valeur d’option.

Note

Si vous recevez un SocketException, utilisez la SocketException.ErrorCode propriété pour obtenir le code d’erreur spécifique. Une fois que vous avez obtenu ce code, reportez-vous à la documentation du code d’erreur de l’API Windows Sockets version 2 pour obtenir une description détaillée de l’erreur.

Note

Ce membre génère des informations de suivi lorsque vous activez le suivi réseau dans votre application. Pour plus d’informations, consultez Suivi réseau dans .NET Framework.

Voir aussi

• SocketOptionName
• SocketOptionLevel
• GetSocketOption(SocketOptionLevel, SocketOptionName)

SetSocketOption(SocketOptionLevel, SocketOptionName, Int32)

Source:

Socket.cs

Définit l’option spécifiée Socket sur la valeur entière spécifiée.

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)

Paramètres

optionLevel

SocketOptionLevel

Une des SocketOptionLevel valeurs.

optionName

SocketOptionName

Une des SocketOptionName valeurs.

optionValue

Int32

Valeur de l’option.

Exceptions

SocketException

Une erreur s’est produite lors de la tentative d’accès au socket.

ObjectDisposedException

Il Socket a été fermé.

Exemples

L’exemple de code suivant définit les LingerOption valeurs et Send le délai d’attente.

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

Remarques

Socket les options déterminent le comportement du actif Socket. Pour une option avec un Boolean type de données, spécifiez une valeur différente de zéro pour activer l’option et une valeur zéro pour désactiver l’option. Pour une option avec un type de données entier, spécifiez la valeur appropriée. Socket les options sont regroupées par niveau de prise en charge du protocole.

Vous trouverez ci-dessous les différentes Socket options qui peuvent être définies à l’aide de cette surcharge. Ces options sont regroupées par les éléments appropriés SocketOptionLevel. Si vous envisagez de définir l’une de ces options, veillez à utiliser la valeur appropriée SocketOptionLevel pour le optionLevel paramètre. L’option que vous choisissez de définir doit être spécifiée dans le optionName paramètre. Si vous souhaitez obtenir la valeur actuelle de l’une des options répertoriées, utilisez la GetSocketOption méthode.

SocketOptionLevel.Socket options qui peuvent être définies à l’aide de cette surcharge.

• Broadcast

• DontLinger

• Debug

• Error

• KeepAlive

• OutOfBandInline

• ReceiveBuffer

• ReceiveTimeout

• ReuseAddress

• SendBuffer

• SendTimeout

• Type

SocketOptionLevel.IP options qui peuvent être définies à l’aide de cette surcharge.

• HeaderIncluded

• IPOptions

• IpTimeToLive

• MulticastInterface

• MulticastLoopback

• MulticastTimeToLive

• TypeOfService

• UseLoopback

SocketOptionLevel.Tcp options qui peuvent être définies à l’aide de cette surcharge.

• BsdUrgent

• Expedited

• NoDelay

SocketOptionLevel.Udp options qui peuvent être définies à l’aide de cette surcharge.

• ChecksumCoverage

• NoChecksum

SocketOptionLevel.IPv6 options qui peuvent être définies à l’aide de cette surcharge.

• HopLimit

Pour plus d’informations sur ces options, reportez-vous à l’énumération SocketOptionName .

Note

Si vous recevez un SocketException, utilisez la SocketException.ErrorCode propriété pour obtenir le code d’erreur spécifique. Une fois que vous avez obtenu ce code, reportez-vous à la documentation du code d’erreur de l’API Windows Sockets version 2 pour obtenir une description détaillée de l’erreur.

Note

Ce membre génère des informations de suivi lorsque vous activez le suivi réseau dans votre application. Pour plus d’informations, consultez Suivi réseau dans .NET Framework.

Voir aussi

• SocketOptionName
• SocketOptionLevel
• GetSocketOption(SocketOptionLevel, SocketOptionName)

SetSocketOption(SocketOptionLevel, SocketOptionName, Object)

Source:

Socket.cs

Définit l’option spécifiée Socket sur la valeur spécifiée, représentée en tant qu’objet.

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)

Paramètres

optionLevel

SocketOptionLevel

Une des SocketOptionLevel valeurs.

optionName

SocketOptionName

Une des SocketOptionName valeurs.

optionValue

Object

MulticastOption Valeur LingerOption de l’option ou qui contient la valeur de l’option.

Exceptions

ArgumentNullException

optionValue a la valeur null.

SocketException

Une erreur s’est produite lors de la tentative d’accès au socket.

ObjectDisposedException

Il Socket a été fermé.

Exemples

L’exemple de code suivant définit les valeurs et Send délai d’attenteLingerOption.

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

Remarques

Socket les options déterminent le comportement du actif Socket. Utilisez cette surcharge pour définir les options et AddMembershipDropMembershipSocket les Lingeroptions. Pour l’option Linger , utilisez Socket le optionLevel paramètre. Pour AddMembership et DropMembership, utilisez IP. Si vous souhaitez obtenir la valeur actuelle de l’une des options répertoriées ci-dessus, utilisez la GetSocketOption méthode.

Note

Si vous recevez un SocketException, utilisez la SocketException.ErrorCode propriété pour obtenir le code d’erreur spécifique. Une fois que vous avez obtenu ce code, reportez-vous à la documentation du code d’erreur de l’API Windows Sockets version 2 pour obtenir une description détaillée de l’erreur.

Voir aussi

• SocketOptionName
• SocketOptionLevel
• GetSocketOption(SocketOptionLevel, SocketOptionName)