Get Received SSH Text into a StringBuilder

See more SSH Examples

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 Go Downloads

Download Chilkat for Go

    success := false

    //  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.

    ssh := chilkat.NewSsh()

    sshPort := 22
    success = ssh.Connect("ssh.example.com",sshPort)
    if success == false {
        fmt.Println(ssh.LastErrorText())
        ssh.DisposeSsh()
        return
    }

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

    success = ssh.AuthenticatePw("mySshLogin",password)
    if success == false {
        fmt.Println(ssh.LastErrorText())
        ssh.DisposeSsh()
        return
    }

    channelNum := ssh.OpenSessionChannel()
    if channelNum < 0 {
        fmt.Println(ssh.LastErrorText())
        ssh.DisposeSsh()
        return
    }

    success = ssh.SendReqExec(channelNum,"ls -l /tmp")
    if success == false {
        fmt.Println(ssh.LastErrorText())
        ssh.DisposeSsh()
        return
    }

    //  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.SetReadTimeoutMs(15000)

    success = ssh.ChannelReceiveToClose(channelNum)
    if success == false {
        fmt.Println(ssh.LastErrorText())
        ssh.DisposeSsh()
        return
    }

    //  Append the received text to a StringBuilder.  Existing content is preserved.
    sb := chilkat.NewStringBuilder()
    success = ssh.GetReceivedSb(channelNum,"utf-8",sb)
    if success == false {
        fmt.Println(ssh.LastErrorText())
        ssh.DisposeSsh()
        sb.DisposeStringBuilder()
        return
    }

    fmt.Println("Characters received: ", sb.Length())
    output := sb.GetAsString()
    fmt.Println(*output)

    ssh.Disconnect()

    ssh.DisposeSsh()
    sb.DisposeStringBuilder()