Daniel Stenberg e694c8284a

docs/libcurl/opts: clarify the return values

Expand a little.

- mention the type name of the return code
- avoid stating which exact return codes that might be returned, as that
  varies over time, builds and conditions
- avoid stating some always return OK
- refer to the manpage documenting all the return codes

Closes #15900

2025-01-02 17:13:33 +01:00

1.2 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

Added-in

curl

CURLMOPT_MAX_CONCURRENT_STREAMS

libcurl

CURLMOPT_MAXCONNECTS (3)

CURLOPT_MAXCONNECTS (3)

HTTP

7.67.0

NAME

CURLMOPT_MAX_CONCURRENT_STREAMS - max concurrent streams for http2

SYNOPSIS

#include <curl/curl.h>

CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_CONCURRENT_STREAMS,
                            long max);

DESCRIPTION

Pass a long indicating the max. The set number is used as the maximum number of concurrent streams libcurl should support on connections done using HTTP/2 or HTTP/3.

Valid values range from 1 to 2147483647 (2^31 - 1) and defaults to 100. The value passed here would be honored based on other system resources properties.

DEFAULT

100

%PROTOCOLS%

EXAMPLE

int main(void)
{
  CURLM *m = curl_multi_init();
  /* max concurrent streams 200 */
  curl_multi_setopt(m, CURLMOPT_MAX_CONCURRENT_STREAMS, 200L);
}

%AVAILABILITY%

RETURN VALUE

curl_multi_setopt(3) returns a CURLMcode indicating success or error.

CURLM_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

1.2 KiB Raw Blame History