(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkSocket.pb"
IncludeFile "CkStream.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkDtObj.pb"

Procedure ChilkatExample()

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

    socket.i = CkSocket::ckCreate()
    If socket.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    maxWaitMs.i = 5000
    success.i = CkSocket::ckConnect(socket,"content.dropboxapi.com",443,1,maxWaitMs)
    If success <> 1
        Debug CkSocket::ckLastErrorText(socket)
        Debug "Connect Fail Reason: " + Str(CkSocket::ckConnectFailReason(socket))
        CkSocket::ckDispose(socket)
        ProcedureReturn
    EndIf

    ; Set the upload bandwidth throttle rate to 50000 bytes per second.
    CkSocket::setCkBandwidthThrottleUp(socket, 50000)

    rest.i = CkRest::ckCreate()
    If rest.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Tell the REST object to use the connected socket.
    CkRest::ckUseConnection(rest,socket,1)

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

    ; Add request headers.
    CkRest::ckAddHeader(rest,"Content-Type","application/octet-stream")
    CkRest::ckAddHeader(rest,"Authorization","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
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckAppendString(json,"path","/Homework/lit/hamlet.xml")
    CkJsonObject::ckAppendString(json,"mode","add")
    CkJsonObject::ckAppendBool(json,"autorename",1)
    CkJsonObject::ckAppendBool(json,"mute",0)
    CkRest::ckAddHeader(rest,"Dropbox-API-Arg",CkJsonObject::ckEmit(json))

    ; Almost ready to go...
    ; Let's setup a file stream to point to a file.
    fileStream.i = CkStream::ckCreate()
    If fileStream.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStream::setCkSourceFile(fileStream, "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.)
    responseStr.s = CkRest::ckFullRequestStream(rest,"POST","/2/files/upload",fileStream)
    If CkRest::ckLastMethodSuccess(rest) <> 1
        Debug CkRest::ckLastErrorText(rest)
        CkSocket::ckDispose(socket)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStream::ckDispose(fileStream)
        ProcedureReturn
    EndIf

    ; When successful, Dropbox responds with a 200 response code.
    If CkRest::ckResponseStatusCode(rest) <> 200
        ; Examine the request/response to see what happened.
        Debug "response status code = " + Str(CkRest::ckResponseStatusCode(rest))
        Debug "response status text = " + CkRest::ckResponseStatusText(rest)
        Debug "response header: " + CkRest::ckResponseHeader(rest)
        Debug "response body (if any): " + responseStr
        Debug "---"
        Debug "LastRequestStartLine: " + CkRest::ckLastRequestStartLine(rest)
        Debug "LastRequestHeader: " + CkRest::ckLastRequestHeader(rest)
        CkSocket::ckDispose(socket)
        CkRest::ckDispose(rest)
        CkJsonObject::ckDispose(json)
        CkStream::ckDispose(fileStream)
        ProcedureReturn
    EndIf

    ; The response is JSON.
    jsonResp.i = CkJsonObject::ckCreate()
    If jsonResp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(jsonResp, 0)
    CkJsonObject::ckLoad(jsonResp,responseStr)

    ; Show the JSON response.
    Debug CkJsonObject::ckEmit(jsonResp)

    ; 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:
    size.i = CkJsonObject::ckIntOf(jsonResp,"size")
    Debug "size = " + Str(size)

    rev.s = CkJsonObject::ckStringOf(jsonResp,"rev")
    Debug "rev = " + rev

    clientModified.s = CkJsonObject::ckStringOf(jsonResp,"client_modified")
    ckdt.i = CkDateTime::ckCreate()
    If ckdt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkDateTime::ckSetFromTimestamp(ckdt,clientModified)
    bLocalTime.i = 1
    dt.i = CkDateTime::ckGetDtObj(ckdt,bLocalTime)
    Debug Str(CkDtObj::ckDay(dt)) + "/" + Str(CkDtObj::ckMonth(dt)) + "/" + Str(CkDtObj::ckYear(dt)) + " " + Str(CkDtObj::ckHour(dt)) + ":" + Str(CkDtObj::ckMinute(dt))
    CkDtObj::ckDispose(dt)



    CkSocket::ckDispose(socket)
    CkRest::ckDispose(rest)
    CkJsonObject::ckDispose(json)
    CkStream::ckDispose(fileStream)
    CkJsonObject::ckDispose(jsonResp)
    CkDateTime::ckDispose(ckdt)


    ProcedureReturn
EndProcedure