2024-03-15 20:55:33 -06:00
|
|
|
.\" generated by cd2nroff 0.1 from CURLOPT_HAPROXYPROTOCOL.md
|
2024-08-02 19:52:59 -06:00
|
|
|
.TH CURLOPT_HAPROXYPROTOCOL 3 "2024-08-02" libcurl
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH NAME
|
|
|
|
|
CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol v1 header
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.nf
|
|
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXYPROTOCOL,
|
|
|
|
|
long haproxy_protocol);
|
|
|
|
|
.fi
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
A long parameter set to 1 tells the library to send an HAProxy PROXY
|
|
|
|
|
protocol v1 header at beginning of the connection. The default action is not to
|
|
|
|
|
send this header.
|
|
|
|
|
|
|
|
|
|
This option is primarily useful when sending test requests to a service that
|
|
|
|
|
expects this header.
|
|
|
|
|
|
|
|
|
|
Most applications do not need this option.
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
0, do not send any HAProxy PROXY protocol header
|
|
|
|
|
.SH PROTOCOLS
|
2024-07-29 18:00:04 -06:00
|
|
|
This functionality affects all supported protocols
|
2024-03-15 20:55:33 -06:00
|
|
|
.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_HAPROXYPROTOCOL, 1L);
|
|
|
|
|
ret = curl_easy_perform(curl);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
.fi
|
|
|
|
|
.SH AVAILABILITY
|
2024-07-29 18:00:04 -06:00
|
|
|
Added in curl 7.60.0
|
2024-03-15 20:55:33 -06:00
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
.BR CURLOPT_PROXY (3)
|
