Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_HAPROXYPROTOCOL (3)

Name

CURLOPT_HAPROXYPROTOCOL - send HAProxy PROXY protocol v1 header

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXYPROTOCOL,
long haproxy_protocol);

Description

curl_easy_setopt options                            CURLOPT_HAPROXYPROTOCOL(3)



NAME
       CURLOPT_HAPROXYPROTOCOL - send HAProxy PROXY protocol v1 header

SYNOPSIS
       #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
       HTTP

EXAMPLE
       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
       Along with HTTP. Added in 7.60.0.

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



ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.60.0                    5 Feb 2018
                                                    CURLOPT_HAPROXYPROTOCOL(3)