curl / libcurl / API / curl_easy_setopt / CURLOPT_HAPROXY_CLIENT_IP

CURLOPT_HAPROXY_CLIENT_IP explained

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 numerical address, the library sends this address as client address in the HAProxy PROXY protocol v1 header at beginning of the connection.

This option is an alternative to CURLOPT_HAPROXYPROTOCOL as that one cannot use a specified address.

Using this option multiple times makes the last set string override the previous ones. Set it to NULL to disable its use again.

The application does not have to keep the string around after setting this option.

Default

NULL, no HAProxy header is sent

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  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

Added in curl 8.2.0

Return value

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