63 lines
2.1 KiB
Groff
63 lines
2.1 KiB
Groff
|
.\" generated by cd2nroff 0.1 from CURLOPT_STREAM_WEIGHT.md
|
||
|
|
.TH CURLOPT_STREAM_WEIGHT 3 "2025-07-07" libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_STREAM_WEIGHT \- numerical stream weight
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_WEIGHT, long weight);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Set the long \fIweight\fP to a number between 1 and 256.
|
||
|
|
|
||
|
|
When using HTTP/2, this option sets the individual weight for this particular
|
||
|
|
stream used by the easy \fIhandle\fP. 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 \fICURLMOPT_PIPELINING(3)\fP.
|
||
|
|
|
||
|
|
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. 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).
|
||
|
|
.SH DEFAULT
|
||
|
|
16
|
||
|
|
.SH PROTOCOLS
|
||
|
|
This functionality affects http only
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
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 */
|
||
|
|
}
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH AVAILABILITY
|
||
|
|
Added in curl 7.46.0
|
||
|
|
.SH RETURN VALUE
|
||
|
|
\fIcurl_easy_setopt(3)\fP returns a CURLcode indicating success or error.
|
||
|
|
|
||
|
|
CURLE_OK (0) means everything was OK, non\-zero means an error occurred, see
|
||
|
|
\fIlibcurl\-errors(3)\fP.
|
||
|
|
.SH SEE ALSO
|
||
|
|
.BR CURLMOPT_PIPELINING (3),
|
||
|
|
.BR CURLOPT_PIPEWAIT (3),
|
||
|
|
.BR CURLOPT_STREAM_DEPENDS (3),
|
||
|
|
.BR CURLOPT_STREAM_DEPENDS_E (3)
|