Commit d31ed6ac authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

http2: s/priority/weight

parent 419d410c

docs/libcurl/opts/CURLOPT_STREAM_DEPENDS.3

+1 −1
Original line number Diff line number Diff line
@@ -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), "

docs/libcurl/opts/CURLOPT_STREAM_DEPENDS_E.3

+1 −1
Original line number Diff line number Diff line
@@ -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), "

docs/libcurl/opts/CURLOPT_STREAM_PRIORITY.3→docs/libcurl/opts/CURLOPT_STREAM_WEIGHT.3

+11 −9
Original line number Diff line number Diff line
@@ -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

docs/libcurl/symbols-in-versions

+4 −1
Original line number Diff line number Diff line
@@ -526,6 +526,9 @@ CURLOPT_SSL_VERIFYHOST 7.8.1 
CURLOPT_SSL_VERIFYPEER          7.4.2

CURLOPT_SSL_VERIFYSTATUS        7.41.0

CURLOPT_STDERR                  7.1

CURLOPT_STREAM_DEPENDS          7.46.0

CURLOPT_STREAM_DEPENDS_E        7.46.0

CURLOPT_STREAM_WEIGHT           7.46.0

CURLOPT_TCP_KEEPALIVE           7.25.0

CURLOPT_TCP_KEEPIDLE            7.25.0

CURLOPT_TCP_KEEPINTVL           7.25.0
@@ -677,8 +680,8 @@ CURL_GLOBAL_SSL 7.8 
CURL_GLOBAL_WIN32               7.8.1

CURL_HTTP_VERSION_1_0           7.9.1

CURL_HTTP_VERSION_1_1           7.9.1

CURL_HTTP_VERSION_2_0           7.33.0

CURL_HTTP_VERSION_2             7.43.0

CURL_HTTP_VERSION_2_0           7.33.0

CURL_HTTP_VERSION_NONE          7.9.1

CURL_IPRESOLVE_V4               7.10.8

CURL_IPRESOLVE_V6               7.10.8

include/curl/curl.h

+2 −2
Original line number Diff line number Diff line
@@ -1648,8 +1648,8 @@ typedef enum { 
  /* Set the protocol used when curl is given a URL without a protocol */

  CINIT(DEFAULT_PROTOCOL, OBJECTPOINT, 238),



  /* Set stream priority, 1 - 256 */

  CINIT(STREAM_PRIORITY, LONG, 239),

  /* Set stream weight, 1 - 256 (default is 16) */

  CINIT(STREAM_WEIGHT, LONG, 239),



  /* Set stream dependency on another CURL handle */

  CINIT(STREAM_DEPENDS, OBJECTPOINT, 240),