Lua

Send a Staged REST Request with a Binary Body

Demonstrates Rest.SendReqBd, which sends a request whose binary body is read from a BinData, then reads the response in separate steps.

The file paths are relative to the application's current working directory. Absolute paths may also be used. Supply the paths appropriate to your own environment.

Background. The staged request model separates sending from reading: a SendReq method transmits the request, ReadResponseHeader reads the status line and headers, and a ReadResp method reads the body. This gives fine control over large or streamed messages compared with the single-call full-request methods.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

local rest = chilkat.Rest.new()
local bTls = true
local bAutoReconnect = true
local success = rest:connect("example.com", 443, bTls, bAutoReconnect)
if not success then
    print(rest.last_error_text)
    return
end

-- The file paths are relative to the application's current working directory.  Absolute paths
-- may also be used.  Supply the paths appropriate to your own environment.

-- Send a request whose binary body is read from a BinData.
local bdBody = chilkat.BinData.new()
local bLoaded = bdBody:load_file("qa_data/image.png")
if not bLoaded then
    print("Failed to load the request body file.")
    return
end

rest:add_header("Content-Type", "image/png")

success = rest:send_req_bd("PUT", "/api/images/1", bdBody)
if not success then
    print(rest.last_error_text)
    return
end

-- After sending, read the response status line and header fields.  The return value is the HTTP
-- status code, or -1 if no response was received.
local statusCode = rest:read_response_header()
if statusCode < 0 then
    print(rest.last_error_text)
    return
end

print("Response status code: " .. statusCode)

-- Read the response body as text.
local responseBody = rest:read_resp_body_string()
if not rest.last_method_success then
    print(rest.last_error_text)
    return
end

print(responseBody)