CURLOPT_STREAM_DEPENDS_E.3 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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.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 \- stream this transfer depends on exclusively
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_DEPENDS_E,
  30. CURL *dephandle);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a CURL * pointer in \fIdephandle\fP to identify the stream within the
  34. same connection that this stream is depending upon exclusively. That means it
  35. depends on it and sets the Exclusive bit.
  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. 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. This option can be set during transfer.
  42. \fIdephandle\fP must not be the same as \fIhandle\fP, that will cause this
  43. function to return an error. It must be another easy handle, and it also needs
  44. to be a handle of a transfer that will be sent over the same HTTP/2 connection
  45. for this option to have an actual effect.
  46. .SH DEFAULT
  47. NULL
  48. .SH PROTOCOLS
  49. HTTP/2
  50. .SH EXAMPLE
  51. .nf
  52. CURL *curl = curl_easy_init();
  53. CURL *curl2 = curl_easy_init(); /* a second handle */
  54. if(curl) {
  55. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/one");
  56. /* the second depends on the first */
  57. curl_easy_setopt(curl2, CURLOPT_URL, "https://example.com/two");
  58. curl_easy_setopt(curl2, CURLOPT_STREAM_DEPENDS_E, curl);
  59. /* then add both to a multi handle and transfer them! */
  60. }
  61. .fi
  62. .SH AVAILABILITY
  63. Added in 7.46.0
  64. .SH RETURN VALUE
  65. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  66. .SH "SEE ALSO"
  67. .BR CURLOPT_STREAM_WEIGHT "(3), " CURLOPT_STREAM_DEPENDS "(3), "