GNURLOPT_STREAM_WEIGHT(3)

💅 GNURLOPT_STREAM_WEIGHT(3) 💅

okay bestie, welcome to the curl_easy_setopt options manual — this page is specifically the GNURLOPT_STREAM_WEIGHT(3) one, and it is literally here to help you set numerical stream weight. no cap. 🫶

---

✨ NAME ✨

CURLOPT_STREAM_WEIGHT — set numerical stream weight 💖

🦋 SYNOPSIS 🦋

#include <gnurl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_WEIGHT, long weight);

💖 DESCRIPTION 💖

You set that long weight to a number between 1 and 256. that’s the whole vibe check for the value.

When you’re using HTTP/2, this option sets the individual weight for this particular stream used by the easy handle. Setting and using weights only makes sense and is only usable when doing multiple streams over the same connections, which thus implies that you use CURLMOPT_PIPELINING(3). so yeah, if you’re not doing multiple streams over the same connections, this is not the move. 🙈

This option can be set during transfer and will then cause the updated weight info to get sent to the server the next time an HTTP/2 frame is sent to the server. lowkey iconic that you can adjust mid-transfer.

See section 5.3 of RFC 7540 for protocol details: https://httpwg.github.io/specs/rfc7540.html#StreamPriority

Streams with the same parent should be allocated resources proportionally based on their weight. So if you have two streams going, stream A with weight 16 and stream B with weight 32, stream B will get two thirds (32/48) of the available bandwidth (assuming the server can send off the data equally for both streams). math ate, fr fr. 🔥

🎀 DEFAULT 🎀

If nothing is set, the HTTP/2 protocol itself will use its own default which is 16. so that’s your fallback, bestie. ✨

🌈 PROTOCOLS 🌈

HTTP/2. only. that’s it. 💅

🔥 EXAMPLE 🔥

CURL *curl = curl_easy_init();
CURL *curl2 = curl_easy_init(); /* a second handle */
if(curl) {
  curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/one");
  curl_easy_setopt(curl, CURLOPT_STREAM_WEIGHT, 10L);

  /* the second has twice the weight */
  curl_easy_setopt(curl2, CURLOPT_URL, "https://example.com/two");
  curl_easy_setopt(curl2, CURLOPT_STREAM_WEIGHT, 20L);

  /* then add both to a multi handle and transfer them! */
}

⭐ AVAILABILITY ⭐

Added in 7.46.0. vintage but still slaying. 🎀

💅 RETURN VALUE 💅

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. that’s the whole mood. 😭

🫶 SEE ALSO 🫶

• CURLOPT_STREAM_DEPENDS(3)
• CURLOPT_STREAM_DEPENDS_E(3)
• CURLOPT_PIPEWAIT(3)
• CURLMOPT_PIPELINING(3),

---

mwah 💋 — this page is from libcurl 7.46.0, dated 13 Sep 2015, and it lives at GNURLOPT_STREAM_WEIGHT(3). periodt. 🌸