(Swift 3,4,5...) SSH ReceiveUntilMatchN

Demonstrates how to call the SSH ChannelReceiveUntilMatchN method.

Chilkat Downloads for the Swift Programming Language MAC OS X (Cocoa) Objective-C/Swift Libs iOS Objective-C/Swift Libs

func chilkatTest() {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    let ssh = CkoSsh()!
    var success: Bool

    // For the sake of the example, pretend the remote shell prompt
    // will be any of the following:
    let saPrompts = CkoStringArray()!

    saPrompts.append("~$")
    saPrompts.append("mars#")
    saPrompts.append("jupiter%")
    saPrompts.append("chilkat$")
    saPrompts.append("admin>")

    var cmdOutput: String?

    // Connect to an SSH server:
    // Hostname may be an IP address or hostname:
    var hostname: String? = "www.some-ssh-server.com"
    var port: Int = 22

    success = ssh.connect(hostname, port: port)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Wait a max of 10 seconds when reading responses..
    ssh.idleTimeoutMs = 10000

    // Authenticate using login/password:
    success = ssh.authenticatePw("myLogin", password: "myPassword")
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Open a session channel.  (It is possible to have multiple
    // session channels open simultaneously.)
    var channelNum: Int = ssh.openSessionChannel().intValue
    if channelNum < 0 {
        print("\(ssh.lastErrorText!)")
        return
    }

    var termType: String? = "dumb"
    var widthInChars: Int = 120
    var heightInChars: Int = 40
    // Use 0 for pixWidth and pixHeight when the dimensions
    // are set in number-of-chars.
    var pixWidth: Int = 0
    var pixHeight: Int = 0
    success = ssh.sendReqPty(channelNum, xTermEnvVar: termType, widthInChars: widthInChars, heightInRows: heightInChars, pixWidth: pixWidth, pixHeight: pixHeight)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Start a shell on the channel:
    success = ssh.sendReqShell(channelNum)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    //  Run the 1st command in the remote shell, which will be to
    //  "cd" to a subdirectory.
    success = ssh.channelSendString(channelNum, strData: "cd workspace\n", charset: "utf-8")
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Retrieve the output to the next prompt:
    var caseSensitiveMatch: Bool = true
    success = ssh.channelReceive(untilMatchN: channelNum, matchPatterns: saPrompts, charset: "utf-8", caseSensitive: caseSensitiveMatch)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    //  Display what we've received so far.  This clears
    //  the internal receive buffer, which is important.
    //  After we send the command, we'll be reading until
    //  the next command prompt.  If the command prompt
    //  is already in the internal receive buffer, it'll think it's
    //  already finished...
    cmdOutput = ssh.getReceivedText(channelNum, charset: "utf-8")
    if ssh.lastMethodSuccess != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    print("\(cmdOutput!)")

    //  Run the 2nd command in the remote shell, which will be
    //  to "ls" the directory.
    success = ssh.channelSendString(channelNum, strData: "ls\n", charset: "utf-8")
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Retrieve and display the output.
    success = ssh.channelReceive(untilMatchN: channelNum, matchPatterns: saPrompts, charset: "utf-8", caseSensitive: caseSensitiveMatch)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    cmdOutput = ssh.getReceivedText(channelNum, charset: "utf-8")
    if ssh.lastMethodSuccess != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    print("\(cmdOutput!)")

    //  Start the final command in the remote shell.  This example
    //  will send a "ls -l" command to retrieve the long format directory listing.
    success = ssh.channelSendString(channelNum, strData: "ls -l\n", charset: "utf-8")
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Send an EOF.  This tells the server that no more data will 
    // be sent on this channel.  The channel remains open, and
    // the SSH client may still receive output on this channel.
    success = ssh.channelSendEof(channelNum)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Read whatever output may already be available on the
    // SSH connection.  ChannelReadAndPoll returns the number of bytes
    // that are available in the channel's internal buffer that
    // are ready to be "picked up" by calling GetReceivedText
    // or GetReceivedData.
    // A return value of -1 indicates failure.
    // A return value of -2 indicates a failure via timeout.

    // The ChannelReadAndPoll method waits
    // for data to arrive on the connection usingi the IdleTimeoutMs
    // property setting.  Once the first data arrives, it continues
    // reading but instead uses the pollTimeoutMs passed in the 2nd argument:
    // A return value of -2 indicates a timeout where no data is received.
    var pollTimeoutMs: Int = 2000
    var n: Int = ssh.channelReadAndPoll(channelNum, pollTimeoutMs: pollTimeoutMs).intValue
    if n < 0 {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Close the channel:
    success = ssh.channelSendClose(channelNum)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Perhaps we did not receive all of the commands output.
    // To make sure,  call ChannelReceiveToClose to accumulate any remaining
    // output until the server's corresponding "channel close" is received.
    success = ssh.channelReceive(toClose: channelNum)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    cmdOutput = ssh.getReceivedText(channelNum, charset: "utf-8")
    if ssh.lastMethodSuccess != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    print("\(cmdOutput!)")

    // Disconnect
    ssh.disconnect()

}