B4X

Get the Type of an Active SSH Channel

Demonstrates the Chilkat Ssh.GetChannelType method, which returns the type of the channel at a zero-based enumeration index. The only argument is the index — an enumeration position, not a channel number. Values include session, x11, forwarded-tcpip, and direct-tcpip.

Background: Paired with GetChannelNumber, this turns the channel collection into a readable inventory of what a connection is currently doing — which channels are running commands (session) versus tunneling TCP traffic (direct-tcpip). That is valuable for diagnostics and for application code that manages several channel kinds at once. An out-of-range index causes the string-returning method to report failure.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the Ssh.GetChannelType method, which returns the type of the channel at a
'  zero-based enumeration index.  The only argument is the index, which is an enumeration
'  position and not a channel number.  Values include "session" and "direct-tcpip".

Dim ssh As ChilkatSsh
ssh.Initialize("ssh")

Dim sshPort As Int = 22
success = ssh.Connect("ssh.example.com", sshPort)
If success = False Then
    Log(ssh.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 = ssh.AuthenticatePw("mySshLogin", password)
If success = False Then
    Log(ssh.LastErrorText)
    Return
End If


Dim channelNum As Int = ssh.OpenSessionChannel
If channelNum < 0 Then
    Log(ssh.LastErrorText)
    Return
End If


'  Enumerate the active channels and report each one's number and type.
Dim n As Int = ssh.NumOpenChannels
Dim i As Int
For i = 0 To n - 1
    Dim chNum As Int = ssh.GetChannelNumber(i)
    Dim chType As String = ssh.GetChannelType(i)
    If ssh.LastMethodSuccess = False Then
        Log(ssh.LastErrorText)
        Return
    End If

    Log("Channel " & chNum & " is of type " & chType)
Next

ssh.Disconnect