Check Whether SSH Channel CLOSE Was Received

See more SSH Examples

Demonstrates the Chilkat Ssh.ChannelReceivedClose method, which reports whether an SSH CLOSE message has been received for a channel. The only argument is the channel number. Remote CLOSE is distinct from EOF and closes the channel in both directions.

integer li_rc
integer li_Success
oleobject loo_Ssh
integer li_SshPort
string ls_Password
integer li_ChannelNum

li_Success = 0

//  Demonstrates the Ssh.ChannelReceivedClose method, which reports whether an SSH CLOSE message
//  has been received for a channel.  The only argument is the channel number.  Remote CLOSE is
//  distinct from EOF and closes the channel in both directions.

loo_Ssh = create oleobject
li_rc = loo_Ssh.ConnectToNewObject("Chilkat.Ssh")
if li_rc < 0 then
    destroy loo_Ssh
    MessageBox("Error","Connecting to COM object failed")
    return
end if

li_SshPort = 22
li_Success = loo_Ssh.Connect("ssh.example.com",li_SshPort)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    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.
ls_Password = "mySshPassword"

li_Success = loo_Ssh.AuthenticatePw("mySshLogin",ls_Password)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

li_ChannelNum = loo_Ssh.OpenSessionChannel()
if li_ChannelNum < 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

li_Success = loo_Ssh.SendReqExec(li_ChannelNum,"ls -l /tmp")
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

//  IMPORTANT: Set a read timeout.  ReadTimeoutMs defaults to 0, which means no limit -- without
//  it, this call waits forever if the server never sends channel close.
loo_Ssh.ReadTimeoutMs = 15000

li_Success = loo_Ssh.ChannelReceiveToClose(li_ChannelNum)
if li_Success = 0 then
    Write-Debug loo_Ssh.LastErrorText
    destroy loo_Ssh
    return
end if

//  The server may send EOF before CLOSE.  During that interval EOF is 1 while CLOSE is
//  still 0.
if loo_Ssh.ChannelReceivedEof(li_ChannelNum) then
    Write-Debug "EOF received."
end if

if loo_Ssh.ChannelReceivedClose(li_ChannelNum) then
    Write-Debug "Remote CLOSE received -- the channel is closed in both directions."
else
    Write-Debug "No remote CLOSE received."
end if

loo_Ssh.Disconnect()


destroy loo_Ssh