C++

HttpPostJson2Async Example

Demonstrates use of the HttpPostJson2Async method. C++

#include <CkHttp.h>
#include <CkTask.h>
#include <CkHttpResponse.h>
#include <CkJsonObject.h>

void ChilkatSample(void)
    {
    bool success = false;

    // This requires the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code

    // See PostJson2 Example for the synchronous equivalent of this example.

    CkHttp http;

    // Sends a POST equivalent to the following CURL command:

    // curl -X POST https://sandbox.plaid.com/institutions/get \
    //   -H 'content-type: application/json' \
    //   -d '{
    //     "client_id": String,
    //     "secret":String,
    //     "count": Number,
    //     "offset": Number
    //   }'

    // Suppress some default headers that would automatically added..
    http.put_AcceptCharset("");
    http.put_UserAgent("");
    http.put_AcceptLanguage("");
    http.put_AllowGzip(false);

    const char *jsonBody = "{\"client_id\": \"PLAID_CLIENT_ID\", \"secret\":\"PLAID_SECRET\", \"count\": 10, \"offset\": 0}";
    CkTask *task = http.PostJson2Async("https://sandbox.plaid.com/institutions/get","application/json",jsonBody);
    if (http.get_LastMethodSuccess() == false) {
        std::cout << http.lastErrorText() << "\r\n";
        return;
    }

    // Start the background task.
    success = task->Run();
    if (!success) {
        std::cout << task->lastErrorText() << "\r\n";
        delete task;
        return;
    }

    // The application is now free to do anything else
    // while the HTTP POST is in progress

    // For this example, we'll simply sleep and periodically
    // check to see if the HTTP POST is finished.  
    while (task->get_Finished() != true) {
        // Sleep 100 ms.
        task->SleepMs(100);
    }

    // When we get here, the task is either finished successfully or not, or was canceled/aborted.

    // If the task was "canceled", it was canceled prior to actually starting.  This could
    // happen if the task was canceled while waiting in a thread pool queue to be scheduled by Chilkat's
    // background thread pool scheduler.  

    // If the task was "aborted", it indicates that it was canceled while running in a background thread.  
    // The ResultErrorText will likely indicate that the task was aborted.

    // If the task "completed", then it ran to completion, but the actual success/failure of the method
    // is determined by getting the result of the underlying method call.
    // A task status of 7 indicates completion.
    if (task->get_StatusInt() != 7) {
        std::cout << "Task did not complete." << "\r\n";
        std::cout << "task status: " << task->status() << "\r\n";
        delete task;
        return;
    }

    // When called synchronously, the PostJson2 method returns an HTTP response object,
    // unless the method failed and there was no response to be had.
    // Check to see if PostJson2 method failed (and thus there is no response object).
    if (task->get_TaskSuccess() == false) {
        std::cout << "The underlying task failed, and there is no HTTP response object." << "\r\n";
        std::cout << "The LastErrorText for the underlying method call is:" << "\r\n";
        std::cout << task->resultErrorText() << "\r\n";
        delete task;
        return;
    }

    // To get the HTTP response object, create a new instance and load it with the result from the task.
    CkHttpResponse resp;
    resp.LoadTaskResult(*task);
    delete task;

    int statusCode = resp.get_StatusCode();
    std::cout << "Response status code = " << statusCode << "\r\n";

    // Examine the JSON response..
    CkJsonObject json;
    json.Load(resp.bodyStr());
    json.put_EmitCompact(false);
    std::cout << "JSON Response Body:" << "\r\n";
    std::cout << json.emit() << "\r\n";
    }