GNURLOPT_HAPROXYPROTOCOL(3)

🎀 GNURLOPT_HAPROXYPROTOCOL(3) 🎀

okay bestie, welcome to the curl_easy_setopt options corner — this page is literally all about CURLOPT_HAPROXYPROTOCOL, and it's giving very specific test-request energy.

---

✨ NAME ✨

CURLOPT_HAPROXYPROTOCOL — send HAProxy PROXY protocol v1 header. no cap, that's the whole name vibe. 💅

---

🦋 SYNOPSIS 🦋

okay so you pull in the header, then call curl_easy_setopt like this:

#include <gnurl/curl.h>

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

---

💅 DESCRIPTION 💅

Here's the tea: you pass a long parameter set to 1, and the library will send an HAProxy PROXY protocol v1 header at the beginning of the connection. The default action? Not sending this header at all — she's lowkey minding her business. 💖

This option is primarily useful when you're sending test requests to a service that expects this header. iykyk. 🧚

Most applications do not need this option. fr fr, don't reach for it unless you know you need it.

---

🌸 DEFAULT 🌸

• 0 — do not send any HAProxy PROXY protocol header. simple as that. 💖

---

🌈 PROTOCOLS 🌈

• HTTP — that's the protocol club for this option. ✨

---

🔥 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. periodt. 👑

---

🫶 RETURN VALUE 🫶

Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not. that's the whole mood. 💀

---

and that's the page, bestie — signing off from libcurl 7.60.0, dated 5 Feb 2018, with main-character energy for GNURLOPT_HAPROXYPROTOCOL(3) 💖✨