GNURLOPT_SOCKOPTDATA(3)

📦 version 7.72.0, in nixos 26.05, nixpkgs unstable

🎀 NAME 🎀

okay bestie, welcome to the GNURLOPT_SOCKOPTDATA(3) page from the curl_easy_setopt options manual. This one is about CURLOPT_SOCKOPTDATA — custom pointer to pass to sockopt callback. That's the whole name, periodt. 💅

✨ SYNOPSIS ✨

#include <gnurl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SOCKOPTDATA, void
*pointer);

🦋 DESCRIPTION 🦋

So you pass a pointer, right? libcurl is gonna leave that pointer completely untouched — hands off, no cap — and it gets passed as the first argument in the sockopt callback that you set with CURLOPT_SOCKOPTFUNCTION(3). That's it. That's the vibe. 🫶

🍓 DEFAULT 🍓

The default value of this parameter is NULL. So if you don't set it, it's just null, bestie. 🙈

🌈 PROTOCOLS 🌈

All — every single protocol. no cap. ✨

🔥 EXAMPLE 🔥

okay here's the cute lil' code moment:

static int sockopt_callback(void *clientp, curl_socket_t curlfd,
                            curlsocktype purpose)
{
  int val = *(int *)clientp;
  setsockopt(curldfd, SOL_SOCKET, SO_RCVBUF, (const char *)&val, sizeof(val));
  return CURL_SOCKOPT_OK;
}

curl = curl_easy_init();
if(curl) {
  int recvbuffersize = 256 * 1024;

  curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/");

  /* call this function to set options for the socket */
  curl_easy_setopt(curl, CURLOPT_SOCKOPTFUNCTION, sockopt_callback);
  curl_easy_setopt(curl, CURLOPT_SOCKOPTDATA, &recvbuffersize);

  res = curl_easy_perform(curl);

  curl_easy_cleanup(curl);
}

💜 AVAILABILITY 💜

Added in 7.16.0. iconic. 👑

⭐ RETURN VALUE ⭐

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

🌸 SEE ALSO 🌸

xoxo, ur Unix bestie 💖 — this page is from libcurl 7.37.0, dated 16 Jun 2014, and it's the GNURLOPT_SOCKOPTDATA(3) manual page. mwah 🎀

📦 where this page comes from