curl / libcurl / API / curl_easy_setopt / CURLOPT_HAPROXYPROTOCOL

CURLOPT_HAPROXYPROTOCOL explained

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

This functionality affects all supported protocols

Example

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

Added in curl 7.60.0

Return value

curl_easy_setopt returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.