Scroll to navigation

CURLOPT_HAPROXY_CLIENT_IP(3) libcurl CURLOPT_HAPROXY_CLIENT_IP(3)

NAME

CURLOPT_HAPROXY_CLIENT_IP - set HAProxy PROXY protocol client IP

SYNOPSIS

#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXY_CLIENT_IP,

char *client_ip);

DESCRIPTION

When this parameter is set to a valid IPv4 or IPv6, the library will not send this address in the HAProxy PROXY protocol v1 header at beginning of the connection.

This option is primarily useful when sending test requests to verify that a service is working as intended.

DEFAULT

no HAProxy header will be sent

PROTOCOLS

HTTP, HAProxy PROTOCOL

EXAMPLE

CURL *curl = curl_easy_init();
if(curl) {

CURLcode ret;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
curl_easy_setopt(curl, CURLOPT_HAPROXY_CLIENT_IP, "1.1.1.1");
ret = curl_easy_perform(curl); }

AVAILABILITY

Along with HTTP. Added in 8.2.0.

RETURN VALUE

Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.

SEE ALSO

CURLOPT_PROXY(3), CURLOPT_HAPROXYPROTOCOL(3),

March 16, 2023 ibcurl 8.2.1