Xbase++

Get Received SSH Text into a StringBuilder

Demonstrates the Chilkat Ssh.GetReceivedSb method, which decodes a channel's receive buffer and appends the text to a StringBuilder. The arguments are the channel number, the charset, and the StringBuilder. The receive buffer is cleared afterward.

Background: Because this appends rather than replaces, it is the natural choice for accumulating output across repeated reads — call it in a loop and the StringBuilder grows into the complete transcript. It also avoids creating a new string on every retrieval, which matters when a command produces a large amount of text.

Chilkat Xbase++ Downloads

Download Chilkat for Xbase++

Xbase++

LOCAL nSuccess
LOCAL oSsh
LOCAL nSshPort
LOCAL cPassword
LOCAL nChannelNum
LOCAL oSb
LOCAL cOutput

nSuccess := 0

//  Demonstrates the Ssh.GetReceivedSb method, which decodes the channel's receive buffer and
//  appends the text to a StringBuilder.  The 1st argument is the channel number, the 2nd is the
//  charset, and the 3rd is the StringBuilder.  The receive buffer is cleared afterward.

oSsh := CreateObject("Chilkat.Ssh")

nSshPort := 22
nSuccess := oSsh:Connect("ssh.example.com", nSshPort)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  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.
cPassword := "mySshPassword"

nSuccess := oSsh:AuthenticatePw("mySshLogin", cPassword)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

nChannelNum := oSsh:OpenSessionChannel()
IF (nChannelNum < 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

nSuccess := oSsh:SendReqExec(nChannelNum, "ls -l /tmp")
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  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.
oSsh:ReadTimeoutMs := 15000

nSuccess := oSsh:ChannelReceiveToClose(nChannelNum)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    RETURN
ENDIF

//  Append the received text to a StringBuilder.  Existing content is preserved.
oSb := CreateObject("Chilkat.StringBuilder")
nSuccess := oSsh:GetReceivedSb(nChannelNum, "utf-8", oSb)
IF (nSuccess == 0)
    ? oSsh:LastErrorText
    oSsh:destroy()
    oSb:destroy()
    RETURN
ENDIF

? "Characters received: " + Str(oSb:Length)
cOutput := oSb:GetAsString()
? cOutput

oSsh:Disconnect()

oSsh:destroy()
oSb:destroy()