Read the REST Response Body in Chunks

See more REST Examples

Demonstrates Rest.ReadRespChunkBd, which reads the response body one chunk at a time, appending each chunk to a BinData. A return value of 0 signals the body is complete, while -1 indicates a read failure.

func chilkatTest() {
    var success: Bool = false

    let rest = CkoRest()!
    var bTls: Bool = true
    var bAutoReconnect: Bool = true
    success = rest.connect(hostname: "example.com", port: 443, tls: bTls, autoReconnect: bAutoReconnect)
    if success == false {
        print("\(rest.lastErrorText!)")
        return
    }

    success = rest.sendReqNoBody(httpVerb: "GET", uriPath: "/api/largefile")
    if success == false {
        print("\(rest.lastErrorText!)")
        return
    }

    var statusCode: Int = rest.readResponseHeader().intValue
    if statusCode < 0 {
        print("\(rest.lastErrorText!)")
        return
    }

    //  Check for the expected success status code.  If the response is not 200, the body is likely
    //  error text formatted as JSON, XML, or HTML rather than the expected content.  In that case read
    //  the body as text, report it, and return.
    if statusCode != 200 {
        let sbError = CkoStringBuilder()!
        success = rest.readRespSb(responseBody: sbError)
        if success == false {
            print("\(rest.lastErrorText!)")
            return
        }

        print("Request failed with status code \(statusCode)")
        print("\(sbError.getAsString()!)")
        return
    }

    //  The status code is 200.  Read the response body in chunks, appending each chunk to the BinData.
    //  Each call waits until at least the requested number of bytes is available, unless the response
    //  ends first.  A return value of 0 means the final bytes were returned and the body is complete;
    //  -1 indicates a read failure.
    let bdBody = CkoBinData()!
    var chunkResult: Int = rest.readRespChunkBd(minSize: 8192, bd: bdBody).intValue
    while chunkResult > 0 {
        chunkResult = rest.readRespChunkBd(minSize: 8192, bd: bdBody).intValue
    }

    if chunkResult < 0 {
        print("\(rest.lastErrorText!)")
        return
    }

    print("Received \(bdBody.numBytes.intValue) bytes.")

}