Xojo Plugin

Release an SSH Channel's Local Resources

Demonstrates the Chilkat Ssh.ChannelRelease method, which releases Chilkat's retained local resources for a channel after all output and exit information has been retrieved. The only argument is the channel number.

Background: Chilkat retains a channel's buffered output and exit information after the channel closes, so you can still read a command's final output. That retention costs memory, and a long-running program that opens many channels should release each one when finished with it. Note this is not a channel-closing method — it sends neither EOF nor CLOSE. Retrieve everything you need first, because releasing discards it.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the Ssh.ChannelRelease method, which releases Chilkat's retained local resources
//  for a channel after all output and exit information has been retrieved.  The only argument is
//  the channel number.

Dim ssh As New Chilkat.Ssh

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

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

//  Open a session channel.  A negative return value indicates failure.
Dim channelNum As Int32
channelNum = ssh.OpenSessionChannel()
If (channelNum < 0) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

success = ssh.SendReqExec(channelNum,"uname -a")
If (success = False) Then
    System.DebugLog(ssh.LastErrorText)
    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.
ssh.ReadTimeoutMs = 15000

//  Retrieve everything of interest before releasing the channel.
success = ssh.ChannelReceiveToClose(channelNum)
If (success = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

Dim output As String
output = ssh.GetReceivedText(channelNum,"utf-8")
If (ssh.LastMethodSuccess = False) Then
    System.DebugLog(ssh.LastErrorText)
    Return
End If

System.DebugLog(output)

//  Release the retained local resources.  This does not send EOF or CLOSE.
ssh.ChannelRelease channelNum

ssh.Disconnect