B4X

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 B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  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.

Dim tunnel As ChilkatSshTunnel
tunnel.Initialize("tunnel")

tunnel.DestHostname = "db.internal.example.com"
tunnel.DestPort = 5432

Dim sshPort As Int = 22
success = tunnel.Connect("ssh.example.com", sshPort)
If success = False Then
    Log(tunnel.LastErrorText)
    Return
End If


'  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.
Dim password As String = "mySshPassword"

success = tunnel.AuthenticatePw("mySshLogin", password)
If success = False Then
    Log(tunnel.LastErrorText)
    Return
End If


Dim listenPort As Int = 1080
success = tunnel.BeginAccepting(listenPort)
If success = False Then
    Log(tunnel.LastErrorText)
    Return
End If


'  ... the tunnel runs ...

'  Shut everything down: disconnect clients and stop the tunnel-manager thread.  With
'  waitForThreads True, the method waits for the worker threads to exit.
Dim waitForThreads As Boolean = True
success = tunnel.CloseTunnel(waitForThreads)
If success = False Then
    Log(tunnel.LastErrorText)
    Return
End If

Log("Tunnel closed.")