Lua Requires Chilkat v11.0.0+

How to Avoid Large Strings in HTTP Responses

See more HTTP Examples

In some programming languages/environments, returning and passing large strings is problematic for both performance and other reasons (for example, with SQL Server limitations on sizes varchar variables).

One way of avoiding the need to return the actual string data, is to pass the data from one place to another via a Chilkat StringBuilder or BinData object. This example demonstrates a simple HTTP GET where the response body contains XML approximately 274K in size. The response body is loaded into the Chilkat.Xml without the XML content ever needing to leave the native code internal to Chilkat.

Lua

local chilkat = require("chilkat")

-- This example assumes the Chilkat HTTP API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

local http = chilkat.Http.new()

local resp = chilkat.HttpResponse.new()
local success = http:http_no_body("GET", "https://www.chilkatsoft.com/hamlet.xml", resp)
if not success then
    print(http.last_error_text)
    return
end

local sb = chilkat.StringBuilder.new()
-- Copy the response body to sb.
success = resp:get_body_sb(sb)

local xml = chilkat.Xml.new()
-- Load the XML from the sb.
local bAutoTrim = false
success = xml:load_sb(sb, bAutoTrim)

print("The response body was " .. sb.length .. " characters in length.")
print("Success.")

-- The output is:
--
--     The response body was 279658 characters in length.
--     Success.