| 123456789101112131415161718192021222324252627282930313233343536373839404142 |
- .\" generated by cd2nroff 0.1 from CURLOPT_HAPROXY_CLIENT_IP.md
- .TH CURLOPT_HAPROXY_CLIENT_IP 3 "2025-01-17" libcurl
- .SH NAME
- CURLOPT_HAPROXY_CLIENT_IP \- set HAProxy PROXY protocol client IP
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXY_CLIENT_IP,
- char *client_ip);
- .fi
- .SH 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 \fICURLOPT_HAPROXYPROTOCOL(3)\fP as that one
- cannot use a specified address.
- .SH DEFAULT
- NULL, no HAProxy header is sent
- .SH PROTOCOLS
- This functionality affects all supported protocols
- .SH EXAMPLE
- .nf
- 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);
- }
- }
- .fi
- .SH AVAILABILITY
- Added in curl 8.2.0
- .SH RETURN VALUE
- Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
- .SH SEE ALSO
- .BR CURLOPT_HAPROXYPROTOCOL (3),
- .BR CURLOPT_PROXY (3)
|
