CURLOPT_STREAM_WEIGHT(3)

๐ŸŽ€ NAME ๐ŸŽ€

okay bestie, welcome to the libcurl page for CURLOPT_STREAM_WEIGHT(3), from the Library Functions Manual โ€” and it is literally all about numerical stream weight ๐Ÿ’…

  • CURLOPT_STREAM_WEIGHT โ€” numerical stream weight, periodt.

โœจ SYNOPSIS โœจ

include the header, then call it like this:

#include <curl/curl.h>

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

๐Ÿ’– DESCRIPTION ๐Ÿ’–

Set the long weight to a number between 1 and 256.

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).

This option can be set during transfer and causes the updated weight info get sent to the server the next time an HTTP/2 frame is sent to the server.

See section 5.3 of RFC 7540 for protocol details ๐Ÿ‘‘

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 gets two thirds (32/48) of the available bandwidth (assuming the server can send off the data equally for both streams). math is mathing, no cap ๐Ÿงฎโœจ


๐ŸŒธ DEFAULT ๐ŸŒธ

16 โ€” that's the default, bestie.


๐Ÿฆ‹ PROTOCOLS ๐Ÿฆ‹

This functionality affects http only.


๐Ÿ“ EXAMPLE ๐Ÿ“

here's the whole example, pls enjoy:

int main(void)
{
  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 curl 7.46.0.


๐Ÿ’œ RETURN VALUE ๐Ÿ’œ

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).


๐ŸŒˆ SEE ALSO ๐ŸŒˆ

go peek at these besties:


signing off from the libcurl manual, dated 2026-10-12, on the CURLOPT_STREAM_WEIGHT(3) page โ€” mwah ๐Ÿ’‹

๐Ÿ“ฆ where this page comes from