Xojo Plugin

Get an SSH Tunnel's Current State (Diagnostics)

Demonstrates the Chilkat SshTunnel.GetCurrentState method, which returns an XML snapshot describing the tunnel manager, SSH channels, and current tunnel clients. It takes no arguments and is intended for diagnostics and monitoring.

Background: Because the tunnel forwards traffic on a background thread, there is no natural place in your code to observe what it is doing at a given moment. GetCurrentState provides that visibility — byte counts, active channels, and connected clients — as structured XML suited to logging or a monitoring dashboard. It is a read-only snapshot and does not affect the tunnel.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the SshTunnel.GetCurrentState method, which returns an XML snapshot describing the
//  tunnel manager, SSH channels, and current tunnel clients.  It takes no arguments and is
//  intended for diagnostics and monitoring.

Dim tunnel As New Chilkat.SshTunnel

//  The tunnel forwards accepted local connections to this destination through the SSH server.
tunnel.DestHostname = "db.internal.example.com"
tunnel.DestPort = 5432

//  Connect to the SSH server.  This performs the TCP/proxy connection and SSH handshake, but
//  does not authenticate yet.
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

//  Begin accepting so there is live tunnel state to inspect.
Dim listenPort As Int32
listenPort = 1080
success = tunnel.BeginAccepting(listenPort)
If (success = False) Then
    System.DebugLog(tunnel.LastErrorText)
    Return
End If

//  Get a diagnostic snapshot of the tunnel's current state as XML.
Dim stateXml As String
stateXml = tunnel.GetCurrentState()
If (tunnel.LastMethodSuccess = False) Then
    System.DebugLog(tunnel.LastErrorText)
    Return
End If

System.DebugLog(stateXml)

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