Xbase++

Disconnect All SSH Tunnel Clients

Demonstrates the Chilkat SshTunnel.DisconnectAllClients method, which disconnects all active tunnel clients while leaving the listener and SSH connection available. The only argument (waitForThreads) selects whether to wait for the client threads to exit.

Background: This is the complement of StopAccepting: it clears out current clients but keeps accepting new ones, so the listener and SSH transport stay up. It is useful for forcibly resetting stuck or unwanted connections without tearing down the whole tunnel — for example, dropping all sessions before a maintenance action while leaving the tunnel ready to serve fresh connections immediately afterward.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oTunnel
LOCAL nSshPort
LOCAL cPassword
LOCAL nListenPort
LOCAL nWaitForThreads
LOCAL nWaitForThreadExit

nSuccess := 0

//  Demonstrates the SshTunnel.DisconnectAllClients method, which disconnects all active tunnel
//  clients while leaving the listener and SSH connection available.  The only argument
//  (waitForThreads) selects whether to wait for the client threads to exit.

oTunnel := CreateObject("Chilkat.SshTunnel")

oTunnel:DestHostname := "db.internal.example.com"
oTunnel:DestPort := 5432

nSshPort := 22
nSuccess := oTunnel:Connect("ssh.example.com", nSshPort)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

//  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.
cPassword := "mySshPassword"

nSuccess := oTunnel:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

nListenPort := 1080
nSuccess := oTunnel:BeginAccepting(nListenPort)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

//  ... clients connect and transfer data ...

//  Disconnect all current clients.  The listener keeps running and will accept new clients.
nWaitForThreads := 1
nSuccess := oTunnel:DisconnectAllClients(nWaitForThreads)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

? "All current clients disconnected; still accepting new ones."

nWaitForThreadExit := 1
nSuccess := oTunnel:CloseTunnel(nWaitForThreadExit)
IF (nSuccess == 0)
    ? oTunnel:LastErrorText
    oTunnel:destroy()
    RETURN
ENDIF

oTunnel:destroy()