Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3, revision 1.1.1.1
1.1 misho 1: .\" **************************************************************************
2: .\" * _ _ ____ _
3: .\" * Project ___| | | | _ \| |
4: .\" * / __| | | | |_) | |
5: .\" * | (__| |_| | _ <| |___
6: .\" * \___|\___/|_| \_\_____|
7: .\" *
8: .\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
9: .\" *
10: .\" * This software is licensed as described in the file COPYING, which
11: .\" * you should have received as part of this distribution. The terms
12: .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13: .\" *
14: .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15: .\" * copies of the Software, and permit persons to whom the Software is
16: .\" * furnished to do so, under the terms of the COPYING file.
17: .\" *
18: .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19: .\" * KIND, either express or implied.
20: .\" *
21: .\" **************************************************************************
22: .\"
23: .TH CURLOPT_HAPROXYPROTOCOL 3 "May 18, 2018" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol v1 header
27: .SH SYNOPSIS
28: #include <curl/curl.h>
29:
30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXYPROTOCOL,
31: long haproxy_protocol);
32: .SH DESCRIPTION
33: A long parameter set to 1 tells the library to send an HAProxy PROXY
34: protocol v1 header at beginning of the connection. The default action is not to
35: send this header.
36:
37: This option is primarily useful when sending test requests to a service that
38: expects this header.
39:
40: Most applications do not need this option.
41: .SH DEFAULT
42: 0, do not send any HAProxy PROXY protocol header
43: .SH PROTOCOLS
44: HTTP
45: .SH EXAMPLE
46: .nf
47: CURL *curl = curl_easy_init();
48: if(curl) {
49: CURLcode ret;
50: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
51: curl_easy_setopt(curl, CURLOPT_HAPROXYPROTOCOL, 1L);
52: ret = curl_easy_perform(curl);
53: }
54: .fi
55: .SH AVAILABILITY
56: Along with HTTP. Added in 7.60.0.
57: .SH RETURN VALUE
58: Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>