GNURLOPT_TCP_KEEPIDLE(3)

📦 version 7.72.0, in nixos 26.05, nixpkgs unstable

okay bestie, welcome to GNURLOPT_TCP_KEEPIDLE(3) from the curl_easy_setopt options manual — the page about setting TCP keep-alive idle time wait. Yes, we're talking about how long the OS chills on an idle connection before it starts sending keepalive probes. Let's go 💅✨

🌸 NAME 🌸

CURLOPT_TCP_KEEPIDLE — set TCP keep-alive idle time wait. That's the whole assignment. 💖

✨ SYNOPSIS ✨

#include <gnurl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_KEEPIDLE, long
delay);

🦋 DESCRIPTION 🦋

You pass a long. That sets the delay, in seconds, that the operating system will wait while the connection is idle before sending keepalive probes.

⚠️ caveat, bestie: not all operating systems support this option. So if your OS doesn't have it, that's not a you problem — it's just not supported there. 🫶

🎀 DEFAULT 🎀

Default is 60.

🌈 PROTOCOLS 🌈

All — every protocol, no cap. 💯

🍓 EXAMPLE 🍓

CURL *curl = curl_easy_init();
if(curl) {
  curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");

  /* enable TCP keep-alive for this transfer */
  curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);

  /* set keep-alive idle time to 120 seconds */
  curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);

  /* interval time between keep-alive probes: 60 seconds */
  curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);

  curl_easy_perform(curl);
}

👑 AVAILABILITY 👑

Added in 7.25.0. It's been iconic for a minute. ✨

💜 RETURN VALUE 💜

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

🧚 SEE ALSO 🧚

xoxo, from the libcurl 7.37.0 era, dated 19 Jun 2014 — and yes, this page is GNURLOPT_TCP_KEEPIDLE(3). 💖🫶

📦 where this page comes from