CURLOPT_STREAM_DEPENDS_E(3)

CURLOPT_STREAM_DEPENDS_E3

Stream this transfer depends on exclusively

Usage

#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_DEPENDS_E,
                          CURL *dephandle);

Overview

Pass a CURL pointer in dephandle to identify the stream within the same connection that this stream is depending upon exclusively. That means it depends on it and sets the Exclusive bit.

The spec says "Including a dependency expresses a preference to allocate resources to the identified stream rather than to the dependent stream."

Setting a dependency with the exclusive flag for a reprioritized stream causes all the dependencies of the new parent stream to become dependent on the reprioritized stream.

This option can be set during transfer.

dephandle must not be the same as handle, that makes this function return an error. It must be another easy handle, and it also needs to be a handle of a transfer that is about to be sent over the same HTTP/2 connection for this option to have an actual effect.

Default

NULL

Protocols

HTTP/2

Examples

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");
    /* the second depends on the first */
    curl_easy_setopt(curl2, CURLOPT_URL, "https://example.com/two");
    curl_easy_setopt(curl2, CURLOPT_STREAM_DEPENDS_E, curl);
    /* then add both to a multi handle and transfer them! */
  }
}

Return value

Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

Releases

66 releases since macOS 10.12; the text changed 12 times.

  1. 10.12–10.12.5
  2. 10.12.6–10.14.6
  3. 10.15–11.5
  4. 12.0.1–12.2
  5. 12.3–12.5
  6. 13.0
  7. 13.1
  8. 13.2
  9. 13.3
  10. 13.4
  11. 13.5–14.1
  12. 14.2–14.4
  13. 14.5–26.5

Availability

Added in 7.46.0

From curl 166.0.0.0.1 in macOS 26.5. Parsed by carta from the page's man source.