summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorng0 <ng0@n0.is>2019-11-07 00:47:33 +0000
committerng0 <ng0@n0.is>2019-11-07 00:47:33 +0000
commit73f63bc358b1e4d8337ba20a810ea52208e60304 (patch)
treeb76cb558b0a8ccd90cfdea91168af9f4d4ebcb3c
parent28234953e22cb36a37eb039511d6e1aed7b3db40 (diff)
downloadgnurl-73f63bc358b1e4d8337ba20a810ea52208e60304.tar.gz
gnurl-73f63bc358b1e4d8337ba20a810ea52208e60304.tar.bz2
gnurl-73f63bc358b1e4d8337ba20a810ea52208e60304.zip
mdocml
-rw-r--r--docs/libcurl/opts/GNURLMOPT_MAX_CONCURRENT_STREAMS.364
1 files changed, 37 insertions, 27 deletions
diff --git a/docs/libcurl/opts/GNURLMOPT_MAX_CONCURRENT_STREAMS.3 b/docs/libcurl/opts/GNURLMOPT_MAX_CONCURRENT_STREAMS.3
index ad32cf8e8..3e59209ad 100644
--- a/docs/libcurl/opts/GNURLMOPT_MAX_CONCURRENT_STREAMS.3
+++ b/docs/libcurl/opts/GNURLMOPT_MAX_CONCURRENT_STREAMS.3
@@ -20,37 +20,47 @@
.\" *
.\" **************************************************************************
.\"
-.TH GNURLMOPT_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 <gnurl/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
+.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
+.Sh DEFAULT
100
-.SH PROTOCOLS
+.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), "
+.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