ServicePoint.SetTcpKeepAlive(Boolean, Int32, Int32) Méthode

Définition

Espace de noms:

System.Net

Assembly:

System.Net.ServicePoint.dll

Source:

ServicePoint.cs

Active ou désactive l'option permettant de maintenir une connexion TCP active.

public:
 void SetTcpKeepAlive(bool enabled, int keepAliveTime, int keepAliveInterval);

public void SetTcpKeepAlive (bool enabled, int keepAliveTime, int keepAliveInterval);

member this.SetTcpKeepAlive : bool * int * int -> unit

Public Sub SetTcpKeepAlive (enabled As Boolean, keepAliveTime As Integer, keepAliveInterval As Integer)

Paramètres

enabled

Boolean

Si la valeur est true, l’option de persistance (KeepAlive) du TCP sur une connexion TCP sera activée à l’aide des valeurs keepAliveTime et keepAliveInterval spécifiées.

Si la valeur est false, l'option de persistance du TCP est désactivée et les paramètres restants sont ignorés.

La valeur par défaut est false.

keepAliveTime

Int32

Spécifie le délai d'attente, en millisecondes, sans activité jusqu'à l'envoi du premier paquet persistant.

La valeur doit être supérieure à 0. Si une valeur inférieure ou égale à zéro est passée, une exception ArgumentOutOfRangeException est levée.

keepAliveInterval

Int32

Spécifie l'intervalle, en millisecondes, entre les envois des paquets persistants si aucun accusé de réception n'est reçu.

La valeur doit être supérieure à 0. Si une valeur inférieure ou égale à zéro est passée, une exception ArgumentOutOfRangeException est levée.

Exceptions

ArgumentOutOfRangeException

La valeur spécifiée pour le paramètre keepAliveTime ou keepAliveInterval est inférieure ou égale à 0.

Remarques

Une application peut demander à un fournisseur TCP/IP d’activer l’utilisation de paquets keep-alive sur une connexion TCP. Par défaut, l’utilisation de paquets keep-alive sur une connexion TCP est désactivée.

Les paramètres par défaut lors de l’initialisation d’un socket TCP définissent le délai d’expiration keep-alive sur 2 heures et l’intervalle de conservation sur 1 seconde. Le keepAliveTime paramètre spécifie le délai d’expiration, en millisecondes, sans activité jusqu’à l’envoi du premier paquet keep-alive. Le keepAliveInterval paramètre spécifie l’intervalle, en millisecondes, entre le moment où les paquets keep-alive successifs sont envoyés si aucun accusé de réception n’est reçu. Le nombre de sondes keep-alive ne peut pas être modifié et est défini sur 10.

Si une connexion TCP est supprimée à la suite de conservations actives, un SocketError de NetworkReset est retourné à tous les appels en cours sur le socket, et tous les appels suivants échouent avec un SocketError de NotConnected.