mirror of
https://github.com/moparisthebest/curl
synced 2024-11-11 03:55:03 -05:00
b1199def8c
... and add a little example of what the weight actually means. "Relative proportion of bandwidth".
64 lines
2.6 KiB
Groff
64 lines
2.6 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_STREAM_WEIGHT 3 "13 Sep 2015" "libcurl 7.46.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_STREAM_WEIGHT \- set numerical stream weight
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_WEIGHT, long weight);
|
|
.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 will then cause the updated weight
|
|
info get sent to the server the next time a HTTP/2 frame is sent to the
|
|
server.
|
|
|
|
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).
|
|
.SH DEFAULT
|
|
If nothing is set, the HTTP/2 protocol itself will use its own default which
|
|
is 16.
|
|
.SH PROTOCOLS
|
|
HTTP/2
|
|
.SH EXAMPLE
|
|
TODO
|
|
.SH AVAILABILITY
|
|
Added in 7.46.0
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_STREAM_DEPENDS "(3), " CURLOPT_STREAM_DEPENDS_E "(3), "
|
|
.BR CURLOPT_PIPEWAIT "(3), " CURLMOPT_PIPELINING "(3), "
|