aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2015-10-21 22:47:24 +0200
committerDaniel Stenberg <daniel@haxx.se>2015-10-23 08:22:38 +0200
commitd31ed6ac719cd3c7c1dcac5f9000b19536087b7e (patch)
tree8d958eac17766d96e256d77925fd8c222052a681 /docs/libcurl/opts
parent419d410ca0728ae591af9f58ef2c1f4132b0a21d (diff)
http2: s/priority/weight
Diffstat (limited to 'docs/libcurl/opts')
-rw-r--r--docs/libcurl/opts/CURLOPT_STREAM_DEPENDS.32
-rw-r--r--docs/libcurl/opts/CURLOPT_STREAM_DEPENDS_E.32
-rw-r--r--docs/libcurl/opts/CURLOPT_STREAM_WEIGHT.3 (renamed from docs/libcurl/opts/CURLOPT_STREAM_PRIORITY.3)20
3 files changed, 13 insertions, 11 deletions
diff --git a/docs/libcurl/opts/CURLOPT_STREAM_DEPENDS.3 b/docs/libcurl/opts/CURLOPT_STREAM_DEPENDS.3
index f3dcff31d..081a73250 100644
--- a/docs/libcurl/opts/CURLOPT_STREAM_DEPENDS.3
+++ b/docs/libcurl/opts/CURLOPT_STREAM_DEPENDS.3
@@ -53,4 +53,4 @@ 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_PRIORITY "(3), " CURLOPT_STREAM_DEPENDS_E "(3), "
+.BR CURLOPT_STREAM_WEIGHT "(3), " CURLOPT_STREAM_DEPENDS_E "(3), "
diff --git a/docs/libcurl/opts/CURLOPT_STREAM_DEPENDS_E.3 b/docs/libcurl/opts/CURLOPT_STREAM_DEPENDS_E.3
index 1684c369d..1b3fbfa1c 100644
--- a/docs/libcurl/opts/CURLOPT_STREAM_DEPENDS_E.3
+++ b/docs/libcurl/opts/CURLOPT_STREAM_DEPENDS_E.3
@@ -56,4 +56,4 @@ 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_PRIORITY "(3), " CURLOPT_STREAM_DEPENDS "(3), "
+.BR CURLOPT_STREAM_WEIGHT "(3), " CURLOPT_STREAM_DEPENDS "(3), "
diff --git a/docs/libcurl/opts/CURLOPT_STREAM_PRIORITY.3 b/docs/libcurl/opts/CURLOPT_STREAM_WEIGHT.3
index 4b0f16a95..c292c02e3 100644
--- a/docs/libcurl/opts/CURLOPT_STREAM_PRIORITY.3
+++ b/docs/libcurl/opts/CURLOPT_STREAM_WEIGHT.3
@@ -20,23 +20,25 @@
.\" *
.\" **************************************************************************
.\"
-.TH CURLOPT_STREAM_PRIORITY 3 "13 Sep 2015" "libcurl 7.46.0" "curl_easy_setopt options"
+.TH CURLOPT_STREAM_WEIGHT 3 "13 Sep 2015" "libcurl 7.46.0" "curl_easy_setopt options"
.SH NAME
-CURLOPT_STREAM_PRIORITY \- set numerical stream priority
+CURLOPT_STREAM_WEIGHT \- set numerical stream priority
.SH SYNOPSIS
#include <curl/curl.h>
-CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_PRIORITY, long prio);
+CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_WEIGHT, long prio);
.SH DESCRIPTION
Set the long \fIprio\fP to a number between 1 and 256.
-For protocols with priorities on streams, such as HTTP/2, this option can be
-used to set an individual priority for this particular stream used by the easy
-\fIhandle\fP. Setting and using priorities really 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.
+When using HTTP/2, this option can be used to set an individual weight for
+this particular stream used by the easy \fIhandle\fP. Setting and using
+weights really 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.
+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