Lua

Enumerate Active SSH Channel Numbers

Demonstrates the Chilkat Ssh.GetChannelNumber method, which returns the channel number at a zero-based enumeration index in the active channel collection. The only argument is the index — an enumeration position, not itself a channel number. Valid indexes run from 0 through NumOpenChannels - 1, and out-of-range indexes return -1.

Background: One SSH connection can carry many simultaneous channels, and this method lets you walk the live set rather than tracking every channel number yourself. The index-versus-channel-number distinction is the key point: index 0 is simply the first channel in the collection and may well be channel number 3. As channels open and close the enumeration shifts, so treat an index as valid only for the moment you read it.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Ssh.GetChannelNumber method, which returns the channel number at a
-- zero-based enumeration index in the active channel collection.  The only argument is the
-- index, which is an enumeration position and not itself a channel number.

local ssh = chilkat.Ssh.new()

local sshPort = 22
local success = ssh:connect("ssh.example.com", sshPort)
if not success then
    print(ssh.last_error_text)
    return
end

-- 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.
local password = "mySshPassword"

success = ssh:authenticate_pw("mySshLogin", password)
if not success then
    print(ssh.last_error_text)
    return
end

-- Open a couple of channels so the collection has more than one entry.
local channelA = ssh:open_session_channel()
if channelA < 0 then
    print(ssh.last_error_text)
    return
end

local channelB = ssh:open_session_channel()
if channelB < 0 then
    print(ssh.last_error_text)
    return
end

-- Enumerate the active channels.  Valid indexes are 0 through NumOpenChannels - 1.
local n = ssh.num_open_channels
print("Open channels: " .. n)
for i = 0, n - 1 do
    local chNum = ssh:get_channel_number(i)
    print("Index " .. i .. " is channel number " .. chNum)
end

ssh:disconnect()