Tcl

REST Upload Bandwidth Throttle

See more REST Examples

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

load ./chilkat.dll

set success 0

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

set socket [new_CkSocket]

set maxWaitMs 5000
set success [CkSocket_Connect $socket "content.dropboxapi.com" 443 1 $maxWaitMs]
if {$success != 1} then {
    puts [CkSocket_lastErrorText $socket]
    puts "Connect Fail Reason: [CkSocket_get_ConnectFailReason $socket]"
    delete_CkSocket $socket
    exit
}

# Set the upload bandwidth throttle rate to 50000 bytes per second.
CkSocket_put_BandwidthThrottleUp $socket 50000

set rest [new_CkRest]

# Tell the REST object to use the connected socket.
CkRest_UseConnection $rest $socket 1

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

# Add request headers.
CkRest_AddHeader $rest "Content-Type" "application/octet-stream"
CkRest_AddHeader $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
# }

set json [new_CkJsonObject]

CkJsonObject_AppendString $json "path" "/Homework/lit/hamlet.xml"
CkJsonObject_AppendString $json "mode" "add"
CkJsonObject_AppendBool $json "autorename" 1
CkJsonObject_AppendBool $json "mute" 0
CkRest_AddHeader $rest "Dropbox-API-Arg" [CkJsonObject_emit $json]

# Almost ready to go...
# Let's setup a file stream to point to a file.
set fileStream [new_CkStream]

CkStream_put_SourceFile $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.)
set responseStr [CkRest_fullRequestStream $rest "POST" "/2/files/upload" $fileStream]
if {[CkRest_get_LastMethodSuccess $rest] == 0} then {
    puts [CkRest_lastErrorText $rest]
    delete_CkSocket $socket
    delete_CkRest $rest
    delete_CkJsonObject $json
    delete_CkStream $fileStream
    exit
}

# When successful, Dropbox responds with a 200 response code.
if {[CkRest_get_ResponseStatusCode $rest] != 200} then {
    # Examine the request/response to see what happened.
    puts "response status code = [CkRest_get_ResponseStatusCode $rest]"
    puts "response status text = [CkRest_responseStatusText $rest]"
    puts "response header: [CkRest_responseHeader $rest]"
    puts "response body (if any): $responseStr"
    puts "---"
    puts "LastRequestStartLine: [CkRest_lastRequestStartLine $rest]"
    puts "LastRequestHeader: [CkRest_lastRequestHeader $rest]"
    delete_CkSocket $socket
    delete_CkRest $rest
    delete_CkJsonObject $json
    delete_CkStream $fileStream
    exit
}

# The response is JSON.
set jsonResp [new_CkJsonObject]

CkJsonObject_put_EmitCompact $jsonResp 0
CkJsonObject_Load $jsonResp $responseStr

# Show the JSON response.
puts [CkJsonObject_emit $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:
set size [CkJsonObject_IntOf $jsonResp "size"]
puts "size = $size"

set rev [CkJsonObject_stringOf $jsonResp "rev"]
puts "rev = $rev"

set clientModified [CkJsonObject_stringOf $jsonResp "client_modified"]
set ckdt [new_CkDateTime]

CkDateTime_SetFromTimestamp $ckdt $clientModified
set bLocalTime 1
set dt [new_CkDtObj]

CkDateTime_ToDtObj $ckdt $bLocalTime $dt

puts [CkDtObj_get_Day $dt]/[CkDtObj_get_Month $dt]/[CkDtObj_get_Year $dt] [CkDtObj_get_Hour $dt]:[CkDtObj_get_Minute $dt]

delete_CkSocket $socket
delete_CkRest $rest
delete_CkJsonObject $json
delete_CkStream $fileStream
delete_CkJsonObject $jsonResp
delete_CkDateTime $ckdt
delete_CkDtObj $dt