| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_STREAM_DEPENDS_E 3 "13 Sep 2015" "libcurl 7.46.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_STREAM_DEPENDS_E \- set stream this transfer depends on exclusively |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_DEPENDS_E, CURL *dephandle); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a CURL * pointer in \fIdephandle\fP to identify the stream within the |
| 32 |
same connection that this stream is depending upon exclusively. That means it |
| 33 |
depends on it and sets the Exclusive bit. |
| 34 |
|
| 35 |
The spec says "Including a dependency expresses a preference to allocate |
| 36 |
resources to the identified stream rather than to the dependent stream." |
| 37 |
|
| 38 |
Setting a dependency with the exclusive flag for a reprioritized stream causes |
| 39 |
all the dependencies of the new parent stream to become dependent on the |
| 40 |
reprioritized stream. |
| 41 |
|
| 42 |
This option can be set during transfer. |
| 43 |
|
| 44 |
\fIdephandle\fP must not be the same as \fIhandle\fP, that will cause this |
| 45 |
function to return an error. It must be another easy handle, and it also needs |
| 46 |
to be a handle of a transfer that will be sent over the same HTTP/2 connection |
| 47 |
for this option to have an actual effect. |
| 48 |
.SH DEFAULT |
| 49 |
NULL |
| 50 |
.SH PROTOCOLS |
| 51 |
HTTP/2 |
| 52 |
.SH EXAMPLE |
| 53 |
.nf |
| 54 |
CURL *curl = curl_easy_init(); |
| 55 |
CURL *curl2 = curl_easy_init(); /* a second handle */ |
| 56 |
if(curl) { |
| 57 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/one"); |
| 58 |
|
| 59 |
/* the second depends on the first */ |
| 60 |
curl_easy_setopt(curl2, CURLOPT_URL, "https://example.com/two"); |
| 61 |
curl_easy_setopt(curl2, CURLOPT_STREAM_DEPENDS_E, curl); |
| 62 |
|
| 63 |
/* then add both to a multi handle and transfer them! */ |
| 64 |
} |
| 65 |
.fi |
| 66 |
.SH AVAILABILITY |
| 67 |
Added in 7.46.0 |
| 68 |
.SH RETURN VALUE |
| 69 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 70 |
.SH "SEE ALSO" |
| 71 |
.BR CURLOPT_STREAM_WEIGHT "(3), " CURLOPT_STREAM_DEPENDS "(3), " |