GNURLMOPT_PUSHDATA(3)

πŸ“¦ version 7.72.0, in nixos 26.05, nixpkgs unstable

πŸ’… NAME πŸ’…

CURLMOPT_PUSHDATA β€” the pointer you pass along to the push callback, bestie. This whole thing is the GNURLMOPT_PUSHDATA(3) manual page, and it's lowkey just about handing a pointer to your callback. ✨


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <gnurl/curl.h>

CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PUSHDATA, void *pointer);

🌸 DESCRIPTION 🌸

Okay so you set that pointer to be passed as the last argument to the CURLMOPT_PUSHFUNCTION(3) callback. That's it, that's the vibe.

The pointer will not be touched or used by libcurl itself β€” it only gets passed on to the callback function. No cap. πŸ’–


πŸŽ€ DEFAULT πŸŽ€

NULL β€” that's the default, periodt. πŸ’…


🌈 PROTOCOLS 🌈

HTTP(S) only, bestie. πŸ¦‹


✨ EXAMPLE ✨

This one only allows pushes for file names starting with "push-":

/* only allow pushes for file names starting with "push-" */
int push_callback(CURL *parent,
                  CURL *easy,
                  size_t num_headers,
                  struct curl_pushheaders *headers,
                  void *userp)
{
  char *headp;
  int *transfers = (int *)userp;
  FILE *out;
  headp = curl_pushheader_byname(headers, ":path");
  if(headp && !strncmp(headp, "/push-", 6)) {
    fprintf(stderr, "The PATH is %s\n", headp);

    /* save the push here */
    out = fopen("pushed-stream", "wb");

    /* write to this file */
    curl_easy_setopt(easy, CURLOPT_WRITEDATA, out);

    (*transfers)++; /* one more */

    return CURL_PUSH_OK;
  }
  return CURL_PUSH_DENY;
}

curl_multi_setopt(multi, CURLMOPT_PUSHFUNCTION, push_callback);
curl_multi_setopt(multi, CURLMOPT_PUSHDATA, &counter);

🫢 AVAILABILITY 🫢

Added in 7.44.0 β€” iconic behavior since day one of that release. ⭐


πŸ’œ RETURN VALUE πŸ’œ

Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. Simple as that. πŸ“


πŸ‘‘ SEE ALSO πŸ‘‘

CURLMOPT_PUSHFUNCTION(3), CURLMOPT_PIPELINING(3), CURLOPT_PIPEWAIT(3), RFC7540


mwah πŸ’– this little page is from libcurl 7.44.0, dated 1 Jun 2015 β€” GNURLMOPT_PUSHDATA(3) out! 🫢✨

πŸ“¦ where this page comes from