mirror of https://github.com/KumoCorp/kumomta.git synced 2026-08-20 00:01:15 +00:00

Files

T

Wez Furlong b4aa4a38ec http: allow controlling some timeout and diagnostics on the client

Adds a couple of options that provide more control over the default
timeouts and logging.

These are exposed to the shaping helper as `publish_timeout`,
`publish_pool_idle_timeout` and `publish_connection_verbose`.

2024-04-19 07:44:19 -07:00

1.7 KiB

Raw Permalink Blame History

`kumo.http.build_client({PARAMS})`

Constructs an HTTP client object.

The client maintains state, including a connection pool, that can be used across multiple HTTP requests.

PARAMS is an object-style table with the following keys:

user_agent - optional string that will be used to set the User-Agent header for all requests made by the client
connection_verbose - optional boolean. If true, additional diagnostics around the connection attempt will be logged and can be seen by setting the diagnostic filter to include reqwest=trace. {{since('dev', inline=True)}}
pool_idle_timeout - optional duration. Sets the maximum time that an idle connection remains in the connection pool. The default is 90 seconds. {{since('dev', inline=True)}}.
timeout - optional duration. Sets the default timeout to use for each request made by the client. Can be overridden using the Request object. The default is 60 seconds. {{since('dev', inline=True)}}.

local response = kumo.http.build_client({}):get('https://example.com/'):send()
print(response:status_code(), response:status_reason())
for k, v in pairs(response:headers()) do
  print('Header', k, v)
end
print(response:text())

Client Methods

The returned client object has the following methods:

client:get(URL)

Returns a Request object that has been configured to make a GET request to the specified URL. The URL is a string.

client:post(URL)

Returns a Request object that has been configured to make a POST request to the specified URL. The URL is a string.

client:put(URL)

Returns a Request object that has been configured to make a PUT request to the specified URL. The URL is a string.

1.7 KiB Raw Permalink Blame History

kumo.http.build_client({PARAMS})