GNURLMOPT_PIPELINING(3)

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

πŸ’… GNURLMOPT_PIPELINING(3) β€” aka the curl_multi_setopt options girlies' page πŸŽ€

okay so bestie, welcome to the multi-handle corner of the manual, the one filed under curl_multi_setopt options ✨ grab a boba, this one's about making your connections do double duty.


🌸 NAME 🌸

CURLMOPT_PIPELINING β€” enable HTTP pipelining and multiplexing, no cap πŸ’…


✨ SYNOPSIS ✨

#include <gnurl/curl.h>

CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING, long
bitmask);

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so you pass in that bitmask parameter and it literally tells libcurl to enable HTTP pipelining and/or HTTP/2 multiplexing for this multi handle. that's the whole vibe. πŸ‘‘

When it's enabled, libcurl will attempt to use those protocol features when it's doing parallel requests to the same hosts. sharing is caring fr fr.

For pipelining, this means that if you add a second request that can use an already existing connection, the second request will be "piped" on the same connection rather than being executed in parallel. iconic behavior honestly.

For multiplexing, this means that follow-up requests can re-use an existing connection and send the new request multiplexed over that at the same time as other transfers are already using that single connection. one connection, many transfers, main character energy 🫢

There are several other related options that are interesting to tweak and adjust to alter how libcurl spreads out requests on different connections or not etc. (iykyk, go read those pages.)

The lore πŸ“œ: Before 7.43.0, this option was set to 1 and 0 to enable and disable HTTP/1.1 pipelining. Starting in 7.43.0, bitmask's second bit also has a meaning, and you can ask for pipelining and multiplexing independently of each other by toggling the correct bits. glow-up of the century honestly.

πŸ“ CURLPIPE_NOTHING

Default, which means doing no attempts at pipelining or multiplexing. the chill, do-nothing option.

πŸ“ CURLPIPE_HTTP1

If this bit is set, libcurl will try to pipeline HTTP/1.1 requests on connections that are already established and in use to hosts.

⚠️ heads up bestie: this bit is deprecated and has no effect since version 7.62.0. it's giving retired icon πŸ’€

πŸ“ CURLPIPE_MULTIPLEX

If this bit is set, libcurl will try to multiplex the new transfer over an existing connection if possible. This requires HTTP/2. that's the good stuff ✨


🧚 DEFAULT 🧚

Since 7.62.0, CURLPIPE_MULTIPLEX is enabled by default. πŸŽ‰

Before that, default was CURLPIPE_NOTHING. simpler times.


🌈 PROTOCOLS 🌈

HTTP(S) β€” that's it, that's the list πŸ’…


πŸ”₯ EXAMPLE πŸ”₯

CURLM *m = curl_multi_init();
/* try HTTP/2 multiplexing */
curl_multi_setopt(m, CURLMOPT_PIPELINING, CURLPIPE_MULTIPLEX);

literally three lines and you're multiplexing. ate and left no crumbs 🍰


⭐ AVAILABILITY ⭐

Added in 7.16.0. Multiplex support bit added in 7.43.0. HTTP/1 Pipelining support was disabled in 7.62.0. history lesson over, go forth πŸ¦‹


πŸ’œ RETURN VALUE πŸ’œ

Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. two outcomes, no in-between, periodt.


πŸ‘‘ SEE ALSO πŸ‘‘

(yes CURLMOPT_MAX_HOST_CONNECTIONS(3) is in there twice, the original said it twice, we keep it twice, consistency queen πŸ’…)


🫢 and that's the page! brought to you by libcurl 7.37.0, dated 17 Jun 2014, filed under GNURLMOPT_PIPELINING(3). mwah, go pipeline responsibly πŸ˜­πŸ’–
πŸ“¦ where this page comes from