summaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/GNURLMOPT_MAX_CONCURRENT_STREAMS.3
blob: ced56abfde9f683043d64393d6facca5c2d3f307 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
.\" **************************************************************************
.\" *                                  _   _ ____  _
.\" *  Project                     ___| | | |  _ \| |
.\" *                             / __| | | | |_) | |
.\" *                            | (__| |_| |  _ <| |___
.\" *                             \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
.\" * are also available at https://curl.se/docs/copyright.html.
.\" *
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
.\" * copies of the Software, and permit persons to whom the Software is
.\" * furnished to do so, under the terms of the COPYING file.
.\" *
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
.\" **************************************************************************
.\"
.Dd November 06, 2019
.Dt GNURLMOPT_MAX_CONCURRENT_STREAMS 3
.Os
.Sh NAME
.Nm CURLMOPT_MAX_CONCURRENT_STREAMS ,
.Nm curl_multi_setopt
.Nd set max concurrent streams for http2
.Sh LIBRARY
.Lb libgnurl
.Sh SYNOPSIS
.In gnurl/curl.h
.Ft CURLMcode
.Fn curl_multi_setopt "CURLM *handle" "CURLMOPT_MAX_CONCURRENT_STREAMS" "long max"
.Sh DESCRIPTION
Pass a long indicating the
.Fa max .
The set number will be used as the
maximum number of concurrent streams for a connections that libcurl should
support on connections done using HTTP/2.
Valid values range from 1 to 2147483647 (2^31 - 1) and defaults to 100.  The
value passed here would be honoured based on other system resources
properties.
.Sh DEFAULT
100
.Sh PROTOCOLS
All
.Sh EXAMPLES
.Bd -literal -offset indent
CURLM *m = curl_multi_init();
/* max concurrent streams 200 */
curl_multi_setopt(m, CURLMOPT_MAX_CONCURRENT_STREAMS, 200L);
.Ed
.Sh HISTORY
.Nm
first appeared in in curl 7.67.0.
.Sh RETURN VALUES
Returns
.Va CURLM_OK
if the option is supported, and
.Va CURLM_UNKNOWN_OPTION
if not.
.Sh SEE ALSO
.Xr GNURLOPT_MAXCONNECTS 3 ,
.Xr GNURLMOPT_MAXCONNECTS 3