docs/libcurl/opts/CURLOPT_STREAM_DEPENDS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, 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 3 "13 Sep 2015" "libcurl 7.46.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_STREAM_DEPENDS \- set stream this transfer depends on
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_DEPENDS, 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. This option clears the
  33 exclusive it and is mutually exclusive to the
  34 \fICURLOPT_STREAM_DEPENDS_E(3)\fP option.
  35
  36 The spec says "Including a dependency expresses a preference to allocate
  37 resources to the identified stream rather than to the dependent stream."
  38
  39 This option can be set during transfer.
  40
  41 \fIdephandle\fP must not be the same as \fIhandle\fP, that will cause this
  42 function to return an error. It must be another easy handle, and it also needs
  43 to be a handle of a transfer that will be sent over the same HTTP/2 connection
  44 for this option to have an actual effect.
  45 .SH DEFAULT
  46 NULL
  47 .SH PROTOCOLS
  48 HTTP/2
  49 .SH EXAMPLE
  50 TODO
  51 .SH AVAILABILITY
  52 Added in 7.46.0
  53 .SH RETURN VALUE
  54 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  55 .SH "SEE ALSO"
  56 .BR CURLOPT_STREAM_WEIGHT "(3), " CURLOPT_STREAM_DEPENDS_E "(3), "