TsgcWebSocketClientMetody › Disconnect

Disconnect Metoda

Zamyka połączenie WebSocket synchronicznie i blokuje wywołującego do momentu zakończenia rozłączenia lub upływu limitu czasu.

Składnia

function Disconnect(const aTimeout: Integer = 10000): Boolean;

Parametry

NazwaTypOpis
aTimeoutconst IntegerMaksymalny czas oczekiwania w milisekundach na zamknięcie połączenia. Domyślnie 10000 (10 sekund).

Wartość zwracana

True, gdy klient rozłączył się w pełni w czasie limitu; False, jeśli limit czasu upłynął jako pierwszy. (Boolean)

Uwagi

Disconnect jest blokującym odpowiednikiem ustawienia Active := False. Czyści Active, a następnie czeka na wewnętrzne zdarzenie do czasu zakończenia uzgadniania rozłączenia lub upłynięcia limitu czasu. Jeśli klient jest już rozłączony, metoda zwraca True natychmiast. Gdy włączona jest opcja Options.CleanDisconnect, przed zamknięciem gniazda do serwera wysyłana jest ramka zamknięcia WebSocket. Jeśli potrzebne jest nieblokujące rozłączenie z wątku pomocniczego, należy użyć metody Stop.

Przykład


if oClient.Disconnect(10000) then
  ShowMessage('Disconnected')
else
  ShowMessage('Not Disconnected');

Powrót do metod