Delphi ActiveX

Close an SSH Tunnel (CloseTunnel)

Demonstrates the Chilkat SshTunnel.CloseTunnel method, which disconnects active tunnel clients and stops the tunnel-manager thread. The only argument (waitForThreads) selects whether to wait for the worker threads to exit.

Background: This is the full shutdown — it stops the listener, disconnects clients, and ends the background threads, so it is what you call when the tunnel is no longer needed. Passing true for waitForThreads makes the call block until the workers have actually exited, which matters before the program terminates or reuses the object; if a worker fails to stop, the method returns false and LastErrorText explains why.

Chilkat Delphi ActiveX Downloads

Download Chilkat for Delphi ActiveX

Delphi ActiveX

var
success: Integer;
tunnel: TChilkatSshTunnel;
sshPort: Integer;
password: WideString;
listenPort: Integer;
waitForThreads: Integer;

begin
success := 0;

//  Demonstrates the SshTunnel.CloseTunnel method, which disconnects active tunnel clients and stops
//  the tunnel-manager thread.  The only argument (waitForThreads) selects whether to wait for the
//  worker threads to exit.

tunnel := TChilkatSshTunnel.Create(Self);

tunnel.DestHostname := 'db.internal.example.com';
tunnel.DestPort := 5432;

sshPort := 22;
success := tunnel.Connect('ssh.example.com',sshPort);
if (success = 0) then
  begin
    Memo1.Lines.Add(tunnel.LastErrorText);
    Exit;
  end;

//  Normally you would not hard-code the password in source.  You should instead obtain it
//  from an interactive prompt, environment variable, or a secrets vault.
password := 'mySshPassword';

success := tunnel.AuthenticatePw('mySshLogin',password);
if (success = 0) then
  begin
    Memo1.Lines.Add(tunnel.LastErrorText);
    Exit;
  end;

listenPort := 1080;
success := tunnel.BeginAccepting(listenPort);
if (success = 0) then
  begin
    Memo1.Lines.Add(tunnel.LastErrorText);
    Exit;
  end;

//  ... the tunnel runs ...

//  Shut everything down: disconnect clients and stop the tunnel-manager thread.  With
//  waitForThreads 1, the method waits for the worker threads to exit.
waitForThreads := 1;
success := tunnel.CloseTunnel(waitForThreads);
if (success = 0) then
  begin
    Memo1.Lines.Add(tunnel.LastErrorText);
    Exit;
  end;
Memo1.Lines.Add('Tunnel closed.');