e694c8284a
Expand a little. - mention the type name of the return code - avoid stating which exact return codes that might be returned, as that varies over time, builds and conditions - avoid stating some always return OK - refer to the manpage documenting all the return codes Closes #15900
67 lines
1.3 KiB
Markdown
67 lines
1.3 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_HAPROXYPROTOCOL
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLOPT_PROXY (3)
|
|
Protocol:
|
|
- All
|
|
Added-in: 7.60.0
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_HAPROXYPROTOCOL - send HAProxy PROXY protocol v1 header
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXYPROTOCOL,
|
|
long haproxy_protocol);
|
|
~~~
|
|
|
|
# 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.
|
|
|
|
# DEFAULT
|
|
|
|
0, do not send any HAProxy PROXY protocol header
|
|
|
|
# %PROTOCOLS%
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
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);
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# %AVAILABILITY%
|
|
|
|
# RETURN VALUE
|
|
|
|
curl_easy_setopt(3) returns a CURLcode indicating success or error.
|
|
|
|
CURLE_OK (0) means everything was OK, non-zero means an error occurred, see
|
|
libcurl-errors(3).
|