Unicode C

Viewing a Simple Three-Step Execution Plan

See more CURL Examples

This example demonstrates a straightforward, valid dependency chain that results in a three-step execution plan. The goal is not to execute the requests, but to inspect how the plan is constructed using ExaminePlan.

The target curl command requires {{order_id}}. A helper function is defined to produce order_id, but it depends on customer_id. Another helper function produces customer_id, which depends on account_name.

Because account_name is provided as a known input, the dependency chain can be fully resolved:

• customer_id is obtained from account_name
• order_id is obtained from customer_id
• The target curl command uses order_id

When ExaminePlan is called, it builds and returns a three-step execution plan showing the order in which each function would be executed.

Unicode C

#include <C_CkHttpCurlW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkHttpCurlW httpCurl;
    const wchar_t *targetCurl;
    const wchar_t *fnName;
    HCkJsonObjectW planJson;

    success = FALSE;

    httpCurl = CkHttpCurlW_Create();

    // The target curl command requires {{order_id}}.
    targetCurl = L"curl -X GET https://api.example.com/orders/{{order_id}}";

    // Define a helper function that produces order_id from customer_id.
    fnName = L"getOrderId";
    CkHttpCurlW_AddFunction(httpCurl,fnName,L"curl -X GET https://api.example.com/order-id?customer={{customer_id}}");
    CkHttpCurlW_AddOutput(httpCurl,fnName,L"order.id",L"order_id");

    // Define a helper function that produces customer_id from account_name.
    fnName = L"getCustomerId";
    CkHttpCurlW_AddFunction(httpCurl,fnName,L"curl -X GET https://api.example.com/customer-id?account={{account_name}}");
    CkHttpCurlW_AddOutput(httpCurl,fnName,L"customer.id",L"customer_id");

    // Provide the starting known input.
    CkHttpCurlW_SetVar(httpCurl,L"account_name",L"acme");

    // Examine the execution plan without running any requests.
    planJson = CkJsonObjectW_Create();
    CkJsonObjectW_putEmitCompact(planJson,FALSE);

    success = CkHttpCurlW_ExaminePlan(httpCurl,targetCurl,planJson);

    // Success is expected to be TRUE.
    wprintf(L"success = %d\n",success);

    wprintf(L"%s\n",CkJsonObjectW_emit(planJson));

    // Expected result:
    // 
    // {
    //   "plan": [{
    //     "function": "getCustomerId",
    //     "inputs": ["account_name"],
    //     "outputs": ["customer_id"]
    //   },{
    //     "function": "getOrderId",
    //     "inputs": ["customer_id"],
    //     "outputs": ["order_id"]
    //   },{
    //     "function": "targetCurl",
    //     "inputs": ["order_id"],
    //     "outputs": []
    //   }]
    // }


    CkHttpCurlW_Dispose(httpCurl);
    CkJsonObjectW_Dispose(planJson);

    }