ServicePoint.SetTcpKeepAlive(Boolean, Int32, Int32) Metoda

Definicja

Przestrzeń nazw:

System.Net

Zestaw:

System.Net.ServicePoint.dll

Źródło:

ServicePoint.cs

Włącza lub wyłącza opcję utrzymania aktywności w połączeniu TCP.

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)

Parametry

enabled

Boolean

W przypadku ustawienia wartości true opcja utrzymywania aktywności protokołu TCP w połączeniu TCP zostanie włączona przy użyciu określonych keepAliveTime wartości i keepAliveInterval .

W przypadku ustawienia wartości false opcja zachowaj przy życiu protokołu TCP jest wyłączona, a pozostałe parametry są ignorowane.

Wartość domyślna to false.

keepAliveTime

Int32

Określa limit czasu (w milisekundach) bez działania do momentu wysłania pierwszego pakietu keep-alive.

Wartość musi być większa niż 0. Jeśli jest przekazywana wartość mniejsza lub równa zero, jest zgłaszana ArgumentOutOfRangeException wartość .

keepAliveInterval

Int32

Określa interwał (w milisekundach) między kolejnymi pakietami utrzymania aktywności, jeśli potwierdzenie nie zostanie odebrane.

Wartość musi być większa niż 0. Jeśli jest przekazywana wartość mniejsza lub równa zero, jest zgłaszana ArgumentOutOfRangeException wartość .

Wyjątki

ArgumentOutOfRangeException

Wartość określona dla keepAliveTime parametru lub keepAliveInterval jest mniejsza lub równa 0.

Uwagi

Aplikacja może zażądać, aby dostawca TCP/IP włączył korzystanie z pakietów utrzymywania aktywności w połączeniu TCP. Ustawieniem domyślnym jest to, że korzystanie z pakietów utrzymywania aktywności w połączeniu TCP jest wyłączone.

Ustawienia domyślne, gdy gniazdo TCP jest inicjowane, ustawia limit czasu utrzymania aktywności na 2 godziny, a interwał utrzymania aktywności na 1 sekundę. Parametr keepAliveTime określa limit czasu (w milisekundach) bez działania do momentu wysłania pierwszego pakietu keep-alive. Parametr keepAliveInterval określa interwał (w milisekundach) między kolejnymi pakietami utrzymania aktywności, jeśli nie otrzymasz potwierdzenia. Nie można zmienić liczby sond keep-alive i jest ustawiona na 10.

Jeśli połączenie TCP zostanie porzucone w wyniku utrzymania aktywności, element SocketError z NetworkReset zostanie zwrócony do wszystkich wywołań w toku w gniazda, a wszystkie kolejne wywołania zakończy się niepowodzeniem z wartością .SocketErrorNotConnected