Lianja

Get Text Received on an SSH Channel

Demonstrates the Chilkat Ssh.GetReceivedText method, which decodes and returns all text currently accumulated in a channel's normal receive buffer. The first argument is the channel number and the second is the charset. The receive buffer is cleared after the text is returned.

Background: This is the retrieval half of the read-then-get pattern: a Channel* read or receive call fills the buffer, and this hands you the text. Because the buffer is cleared on retrieval, each call returns only what arrived since the last one. A valid channel with nothing buffered returns an empty string successfully, so an empty result is not an error. Retrieve text promptly after a channel completes, before other SSH operations can discard the completed channel record.

Chilkat Lianja Downloads

Download Chilkat for Lianja

Lianja

llSuccess = .F.

//  Demonstrates the Ssh.GetReceivedText method, which decodes and returns all text currently in
//  a channel's normal receive buffer.  The 1st argument is the channel number and the 2nd is the
//  charset.  The receive buffer is cleared after the text is returned.

loSsh = createobject("CkSsh")

lnSshPort = 22
llSuccess = loSsh.Connect("ssh.example.com",lnSshPort)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    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.
lcPassword = "mySshPassword"

llSuccess = loSsh.AuthenticatePw("mySshLogin",lcPassword)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

lnChannelNum = loSsh.OpenSessionChannel()
if (lnChannelNum < 0) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

llSuccess = loSsh.SendReqExec(lnChannelNum,"cat /etc/hostname")
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    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.
loSsh.ReadTimeoutMs = 15000

llSuccess = loSsh.ChannelReceiveToClose(lnChannelNum)
if (llSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

//  Retrieve the accumulated output.  A valid channel with no buffered data returns an empty
//  string successfully.
lcOutput = loSsh.GetReceivedText(lnChannelNum,"utf-8")
if (loSsh.LastMethodSuccess = .F.) then
    ? loSsh.LastErrorText
    release loSsh
    return
endif

? lcOutput

loSsh.Disconnect()


release loSsh