mirror of
https://github.com/curl/curl.git
synced 2026-08-24 09:13:33 +03:00
eefcc1bda4
curldown is this new file format for libcurl man pages. It is markdown inspired with differences: - Each file has a set of leading headers with meta-data - Supports a small subset of markdown - Uses .md file extensions for editors/IDE/GitHub to treat them nicely - Generates man pages very similar to the previous ones - Generates man pages that still convert nicely to HTML on the website - Detects and highlights mentions of curl symbols automatically (when their man page section is specified) tools: - cd2nroff: converts from curldown to nroff man page - nroff2cd: convert an (old) nroff man page to curldown - cdall: convert many nroff pages to curldown versions - cd2cd: verifies and updates a curldown to latest curldown This setup generates .3 versions of all the curldown versions at build time. CI: Since the documentation is now technically markdown in the eyes of many things, the CI runs many more tests and checks on this documentation, including proselint, link checkers and tests that make sure we capitalize the first letter after a period... Closes #12730
77 lines
1.8 KiB
Markdown
77 lines
1.8 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Title: CURLOPT_STREAM_DEPENDS
|
|
Section: 3
|
|
Source: libcurl
|
|
See-also:
|
|
- CURLMOPT_PIPELINING (3)
|
|
- CURLOPT_HTTP_VERSION (3)
|
|
- CURLOPT_STREAM_DEPENDS_E (3)
|
|
- CURLOPT_STREAM_WEIGHT (3)
|
|
---
|
|
|
|
# NAME
|
|
|
|
CURLOPT_STREAM_DEPENDS - stream this transfer depends on
|
|
|
|
# SYNOPSIS
|
|
|
|
~~~c
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_STREAM_DEPENDS,
|
|
CURL *dephandle);
|
|
~~~
|
|
|
|
# DESCRIPTION
|
|
|
|
Pass a CURL pointer in *dephandle* to identify the stream within the same
|
|
connection that this stream is depending upon. This option clears the
|
|
exclusive bit and is mutually exclusive to the CURLOPT_STREAM_DEPENDS_E(3)
|
|
option.
|
|
|
|
The spec says "Including a dependency expresses a preference to allocate
|
|
resources to the identified stream rather than to the dependent 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
|
|
|
|
# EXAMPLE
|
|
|
|
~~~c
|
|
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, curl);
|
|
|
|
/* then add both to a multi handle and transfer them! */
|
|
}
|
|
}
|
|
~~~
|
|
|
|
# AVAILABILITY
|
|
|
|
Added in 7.46.0
|
|
|
|
# RETURN VALUE
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|