ark::comms::HttpRequestOptions

Defined in header “ark/comms/http_helpers.hh”.

A structure containing more advanced options for complex HTTP requests.

std::string bearer_token
If populated, an authentication header with this bearer token will be applied.
std::string username
If populated, an authentication header with this username will be applied.
std::string password
If populated, an authentication header with this password will be applied.
std::chrono::milliseconds timeout= std::chrono::seconds{60}
The timeout that will be applied to this request.
std::map< std::string, std::string > headers
Headers to attach to this request.
std::chrono::seconds low_speed_time= std::chrono::seconds{60}
Set the amount of time the transaction can be in ’low speed mode’ before we consider the connection timed out.
uint64_t low_speed_limit= 1
If the receive rate is under this limit, then the connection is considered to be in ’low speed mode'.
HttpProgressCallback upload_progress_callback
This callback will be invoked periodically with the number of bytes transferred to the remote host.
HttpProgressCallback download_progress_callback
This callback will be invoked periodically with the number of bytes transferred from the remote host.
std::filesystem::path unix_socket_path
Path to a unix socket. If set, we’ll execute the HTTP request over a unix domain socket instead of over a standard internet socket.