Xojo Plugin

Start an SSH Tunnel Listener (BeginAccepting)

Demonstrates the Chilkat SshTunnel.BeginAccepting method, which creates and starts the local listener on the given port. The only argument is the listen port. Connect and authenticate first — clients accepted before authentication cannot be forwarded. The IsAccepting property reports whether the listener is running.

Background: This is the step that actually turns the object into a working tunnel: it spawns a background thread that accepts local TCP connections and forwards each through the authenticated SSH transport. Because the forwarding runs on its own thread, control returns to your program immediately and the tunnel operates while the rest of the application does other work — which is why a separate CloseTunnel is needed to shut it down cleanly.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the SshTunnel.BeginAccepting method, which creates and starts the local listener
//  on the given port.  The only argument is the listen port.  Connect and authenticate first;
//  clients accepted before authentication cannot be forwarded.

Dim tunnel As New Chilkat.SshTunnel

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

Dim sshPort As Int32
sshPort = 22
success = tunnel.Connect("ssh.example.com",sshPort)
If (success = False) Then
    System.DebugLog(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
password = "mySshPassword"

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

//  Start the local listener.  Local TCP connections to this port are forwarded to DestHostname:DestPort
//  through the SSH server.
Dim listenPort As Int32
listenPort = 1080
success = tunnel.BeginAccepting(listenPort)
If (success = False) Then
    System.DebugLog(tunnel.LastErrorText)
    Return
End If

//  IsAccepting reports whether the listener thread is running.
If (tunnel.IsAccepting) Then
    System.DebugLog("The tunnel is accepting connections on port " + Str(listenPort))
End If

//  ... the tunnel forwards traffic on a background thread while your application runs ...

Dim waitForThreadExit As Boolean
waitForThreadExit = True
success = tunnel.CloseTunnel(waitForThreadExit)
If (success = False) Then
    System.DebugLog(tunnel.LastErrorText)
    Return
End If