diff options
| author | Kunal Ekawde <kunal_ekawde@affirmednetworks.com> | 2019-09-24 08:56:11 -0400 | 
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2019-10-02 07:47:48 +0200 | 
| commit | c124e6b3c04bfd254e24312bc66c2bc9db919442 (patch) | |
| tree | 861a66bb058eb9f51fd7c2d93cf133dd505e577f /docs/libcurl/opts | |
| parent | f0f053fed034bacf956a9f32ea65529b0b123247 (diff) | |
CURLMOPT_MAX_CONCURRENT_STREAMS: new setopt
Closes #4410
Diffstat (limited to 'docs/libcurl/opts')
| -rw-r--r-- | docs/libcurl/opts/CURLMOPT_MAX_CONCURRENT_STREAMS.3 | 56 | ||||
| -rw-r--r-- | docs/libcurl/opts/Makefile.inc | 9 | 
2 files changed, 61 insertions, 4 deletions
diff --git a/docs/libcurl/opts/CURLMOPT_MAX_CONCURRENT_STREAMS.3 b/docs/libcurl/opts/CURLMOPT_MAX_CONCURRENT_STREAMS.3 new file mode 100644 index 000000000..ab044f754 --- /dev/null +++ b/docs/libcurl/opts/CURLMOPT_MAX_CONCURRENT_STREAMS.3 @@ -0,0 +1,56 @@ +.\" ************************************************************************** +.\" *                                  _   _ ____  _ +.\" *  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.haxx.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. +.\" * +.\" ************************************************************************** +.\" +.TH CURLMOPT_MAX_CONCURRENT_STREAMS 3 "06 Nov 2019" "libcurl 7.67.0" "curl_multi_setopt options" +.SH NAME +CURLMOPT_MAX_CONCURRENT_STREAMS \- set max concurrent streams for http2 +.SH SYNOPSIS +.nf +#include <curl/curl.h> + +CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_CONCURRENT_STREAMS, +                            long max); +.fi +.SH DESCRIPTION +Pass a long indicating the \fBmax\fP. 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 EXAMPLE +.nf +  CURLM *m = curl_multi_init(); +  /* max concurrent streams 200 */ +  curl_multi_setopt(m, CURLMOPT_MAX_CONCURRENT_STREAMS, 200L); +.fi +.SH AVAILABILITY +Added in 7.67.0 +.SH RETURN VALUE +Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. +.SH "SEE ALSO" +.BR CURLOPT_MAXCONNECTS "(3), " CURLMOPT_MAXCONNECTS.3 "(3), " diff --git a/docs/libcurl/opts/Makefile.inc b/docs/libcurl/opts/Makefile.inc index b5f62a159..93c4357d2 100644 --- a/docs/libcurl/opts/Makefile.inc +++ b/docs/libcurl/opts/Makefile.inc @@ -68,6 +68,7 @@ man_MANS =                                      \    CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE.3          \    CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE.3        \    CURLMOPT_MAXCONNECTS.3                        \ +  CURLMOPT_MAX_CONCURRENT_STREAMS.3             \    CURLMOPT_MAX_HOST_CONNECTIONS.3               \    CURLMOPT_MAX_PIPELINE_LENGTH.3                \    CURLMOPT_MAX_TOTAL_CONNECTIONS.3              \ @@ -97,7 +98,6 @@ man_MANS =                                      \    CURLOPT_CHUNK_END_FUNCTION.3                  \    CURLOPT_CLOSESOCKETDATA.3                     \    CURLOPT_CLOSESOCKETFUNCTION.3                 \ -  CURLOPT_UPKEEP_INTERVAL_MS.3             \    CURLOPT_CONNECTTIMEOUT.3                      \    CURLOPT_CONNECTTIMEOUT_MS.3                   \    CURLOPT_CONNECT_ONLY.3                        \ @@ -113,8 +113,8 @@ man_MANS =                                      \    CURLOPT_COPYPOSTFIELDS.3                      \    CURLOPT_CRLF.3                                \    CURLOPT_CRLFILE.3                             \ -  CURLOPT_CUSTOMREQUEST.3                       \    CURLOPT_CURLU.3                               \ +  CURLOPT_CUSTOMREQUEST.3                       \    CURLOPT_DEBUGDATA.3                           \    CURLOPT_DEBUGFUNCTION.3                       \    CURLOPT_DEFAULT_PROTOCOL.3                    \ @@ -168,8 +168,6 @@ man_MANS =                                      \    CURLOPT_HTTP_TRANSFER_DECODING.3              \    CURLOPT_HTTP_VERSION.3                        \    CURLOPT_IGNORE_CONTENT_LENGTH.3               \ -  CURLOPT_TRAILERDATA.3                         \ -  CURLOPT_TRAILERFUNCTION.3                     \    CURLOPT_INFILESIZE.3                          \    CURLOPT_INFILESIZE_LARGE.3                    \    CURLOPT_INTERFACE.3                           \ @@ -332,10 +330,13 @@ man_MANS =                                      \    CURLOPT_TLSAUTH_PASSWORD.3                    \    CURLOPT_TLSAUTH_TYPE.3                        \    CURLOPT_TLSAUTH_USERNAME.3                    \ +  CURLOPT_TRAILERDATA.3                         \ +  CURLOPT_TRAILERFUNCTION.3                     \    CURLOPT_TRANSFERTEXT.3                        \    CURLOPT_TRANSFER_ENCODING.3                   \    CURLOPT_UNIX_SOCKET_PATH.3                    \    CURLOPT_UNRESTRICTED_AUTH.3                   \ +  CURLOPT_UPKEEP_INTERVAL_MS.3                  \    CURLOPT_UPLOAD.3                              \    CURLOPT_UPLOAD_BUFFERSIZE.3                   \    CURLOPT_URL.3                                 \  | 
