(Swift 3,4,5...) REST Upload Bandwidth Throttle

Demonstrates how to use upload bandwidth throttling with the REST API. This example will upload a file to Drobox using a file stream, with a limit on the bandwidth that can be used for the transfer.

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

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

    // A Dropbox access token should have been previously obtained.
    // Dropbox access tokens do not expire.
    // See Dropbox Access Token.

    // To use bandwidth throttling, the connection should be made using the socket API.
    // This provides numerous properties to customize the connection, such as
    // BandwidthThrottleDown, BandwidthThrottleUp, ClientIpAddress, ClintPort, Http Proxy,
    // KeepAlive, PreferIpv6, RequireSslCertVerify, SoRcvBuf, SoSndBuf, SoReuseAddr,
    // SOCKS proxy, TcpNoSDelay, TlsPinSet, TlsCipherSuite, SslAllowedCiphers, etc.

    let socket = CkoSocket()!
    var maxWaitMs: Int = 5000
    var success: Bool = socket.connect("content.dropboxapi.com", port: 443, ssl: true, maxWaitMs: maxWaitMs)
    if success != true {
        print("\(socket.lastErrorText!)")
        print("Connect Fail Reason: \(socket.connectFailReason.intValue)")
        return
    }

    // Set the upload bandwidth throttle rate to 50000 bytes per second.
    socket.bandwidthThrottleUp = 50000

    let rest = CkoRest()!

    // Tell the REST object to use the connected socket.
    rest.useConnection(socket, autoReconnect: true)

    // The remainder of this example is identical to the example at:
    // Dropbox File Stream Upload.

    // Add request headers.
    rest.addHeader("Content-Type", value: "application/octet-stream")
    rest.addHeader("Authorization", value: "Bearer DROPBOX_ACCESS_TOKEN")

    // The upload "parameters" contained in JSON passed in an HTTP request header.
    // This is the JSON to be added in this example:
    // { 
    //    "path": "/Homework/lit/hamlet.xml",
    //    "mode": "add",
    //    "autorename": true,
    //    "mute": false
    // }

    let json = CkoJsonObject()!
    json.append("path", value: "/Homework/lit/hamlet.xml")
    json.append("mode", value: "add")
    json.appendBool("autorename", value: true)
    json.appendBool("mute", value: false)
    rest.addHeader("Dropbox-API-Arg", value: json.emit())

    // Almost ready to go...
    // Let's setup a file stream to point to a file.
    let fileStream = CkoStream()!
    fileStream.sourceFile = "qa_data/xml/hamlet.xml"

    // Do the upload.  The URL is https://content.dropboxapi.com/2/files/upload.
    // We already connected to content.dropboxapi.com using TLS (i.e. HTTPS),
    // so now we only need to specify the path "/2/files/upload".

    // Note: The file is streamed directly from disk.  (The entire
    // file will not be loaded into memory.)
    var responseStr: String? = rest.fullRequestStream("POST", uriPath: "/2/files/upload", stream: fileStream)
    if rest.lastMethodSuccess != true {
        print("\(rest.lastErrorText!)")
        return
    }

    // When successful, Dropbox responds with a 200 response code.
    if rest.responseStatusCode.intValue != 200 {
        // Examine the request/response to see what happened.
        print("response status code = \(rest.responseStatusCode.intValue)")
        print("response status text = \(rest.responseStatusText!)")
        print("response header: \(rest.responseHeader!)")
        print("response body (if any): \(responseStr!)")
        print("---")
        print("LastRequestStartLine: \(rest.lastRequestStartLine!)")
        print("LastRequestHeader: \(rest.lastRequestHeader!)")
        return
    }

    // The response is JSON.
    let jsonResp = CkoJsonObject()!
    jsonResp.emitCompact = false
    jsonResp.load(responseStr)

    // Show the JSON response.
    print("\(jsonResp.emit()!)")

    // Returns JSON that looks like this:
    // { 
    //   "name": "hamlet.xml",
    //   "path_lower": "/homework/lit/hamlet.xml",
    //   "path_display": "/Homework/lit/hamlet.xml",
    //   "id": "id:74FkdeNuyKAAAAAAAAAAAQ",
    //   "client_modified": "2016-06-02T23:19:00Z",
    //   "server_modified": "2016-06-02T23:19:00Z",
    //   "rev": "9482db15f",
    //   "size": 279658
    // }

    // Sample code to get data from the JSON response:
    var size: Int = jsonResp.int(of: "size").intValue
    print("size = \(size)")

    var rev: String? = jsonResp.string(of: "rev")
    print("rev = \(rev!)")

    var clientModified: String? = jsonResp.string(of: "client_modified")
    let ckdt = CkoDateTime()!
    ckdt.setFromTimestamp(clientModified)
    var bLocalTime: Bool = true
    var dt: CkoDtObj? = ckdt.getDtObj(bLocalTime)
    print("\(dt!.day.intValue)/\(dt!.month.intValue)/\(dt!.year.intValue) \(dt!.hour.intValue):\(dt!.minute.intValue)")
    dt = nil

}