C#

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

bool success = false;

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

Chilkat.Socket socket = new Chilkat.Socket();
int maxWaitMs = 5000;
success = socket.Connect("content.dropboxapi.com",443,true,maxWaitMs);
if (success != true) {
    Debug.WriteLine(socket.LastErrorText);
    Debug.WriteLine("Connect Fail Reason: " + Convert.ToString(socket.ConnectFailReason));
    return;
}

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

Chilkat.Rest rest = new Chilkat.Rest();

//  Tell the REST object to use the connected socket.
rest.UseConnection(socket,true);

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

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

Chilkat.JsonObject json = new Chilkat.JsonObject();
json.AppendString("path","/Homework/lit/hamlet.xml");
json.AppendString("mode","add");
json.AppendBool("autorename",true);
json.AppendBool("mute",false);
rest.AddHeader("Dropbox-API-Arg",json.Emit());

//  Almost ready to go...
//  Let's setup a file stream to point to a file.
Chilkat.Stream fileStream = new Chilkat.Stream();
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.)
string responseStr = rest.FullRequestStream("POST","/2/files/upload",fileStream);
if (rest.LastMethodSuccess == false) {
    Debug.WriteLine(rest.LastErrorText);
    return;
}

//  When successful, Dropbox responds with a 200 response code.
if (rest.ResponseStatusCode != 200) {
    //  Examine the request/response to see what happened.
    Debug.WriteLine("response status code = " + Convert.ToString(rest.ResponseStatusCode));
    Debug.WriteLine("response status text = " + rest.ResponseStatusText);
    Debug.WriteLine("response header: " + rest.ResponseHeader);
    Debug.WriteLine("response body (if any): " + responseStr);
    Debug.WriteLine("---");
    Debug.WriteLine("LastRequestStartLine: " + rest.LastRequestStartLine);
    Debug.WriteLine("LastRequestHeader: " + rest.LastRequestHeader);
    return;
}

//  The response is JSON.
Chilkat.JsonObject jsonResp = new Chilkat.JsonObject();
jsonResp.EmitCompact = false;
jsonResp.Load(responseStr);

//  Show the JSON response.
Debug.WriteLine(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:
int size = jsonResp.IntOf("size");
Debug.WriteLine("size = " + Convert.ToString(size));

string rev = jsonResp.StringOf("rev");
Debug.WriteLine("rev = " + rev);

string clientModified = jsonResp.StringOf("client_modified");
Chilkat.CkDateTime ckdt = new Chilkat.CkDateTime();
ckdt.SetFromTimestamp(clientModified);
bool bLocalTime = true;
Chilkat.DtObj dt = new Chilkat.DtObj();
ckdt.ToDtObj(bLocalTime,dt);

Debug.WriteLine(Convert.ToString(dt.Day) + "/" + Convert.ToString(dt.Month) + "/" + Convert.ToString(dt.Year) + " " + Convert.ToString(dt.Hour) + ":" + Convert.ToString(dt.Minute));