aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLMOPT_PIPELINING.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2014-11-03 23:11:37 +0100
committerDaniel Stenberg <daniel@haxx.se>2014-11-03 23:50:31 +0100
commita14ccfffb88b9d2103009a559361c370e21c2651 (patch)
tree260d6e64a1fefcab03a803bc42691050e45ec83d /docs/libcurl/opts/CURLMOPT_PIPELINING.3
parent15c4d51d39ef8be29005fef58a0bb4d5c84796d5 (diff)
opts: made stand-alone man-pages for several multi options
Diffstat (limited to 'docs/libcurl/opts/CURLMOPT_PIPELINING.3')
-rw-r--r--docs/libcurl/opts/CURLMOPT_PIPELINING.357
1 files changed, 57 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLMOPT_PIPELINING.3 b/docs/libcurl/opts/CURLMOPT_PIPELINING.3
new file mode 100644
index 000000000..ce6bd9b64
--- /dev/null
+++ b/docs/libcurl/opts/CURLMOPT_PIPELINING.3
@@ -0,0 +1,57 @@
+.\" **************************************************************************
+.\" * _ _ ____ _
+.\" * Project ___| | | | _ \| |
+.\" * / __| | | | |_) | |
+.\" * | (__| |_| | _ <| |___
+.\" * \___|\___/|_| \_\_____|
+.\" *
+.\" * Copyright (C) 1998 - 2014, 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 http://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_PIPELINING 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options"
+.SH NAME
+CURLMOPT_PIPELINING \- enable/disable HTTP pipelining
+.SH SYNOPSIS
+#include <curl/curl.h>
+
+CURLcode curl_multi_setopt(CURL *handle, CURLMOPT_PIPELINING, bool onoff);
+.SH DESCRIPTION
+Set the \fBonoff\fP parameter to 1 to make libcurl use HTTP pipelining for
+HTTP transfers done using this multi handle, as far as possible. This means
+that if you add a second request that can use an already existing connection,
+the second request will be \&"piped" on the same connection rather than being
+executed in parallel.
+
+When using pipelining, there are also several other related options that are
+interesting to tweak and adjust to alter how libcurl spreads out requests on
+different connections or not etc.
+.SH DEFAULT
+0 (off)
+.SH PROTOCOLS
+HTTP(S)
+.SH EXAMPLE
+TODO
+.SH AVAILABILITY
+Added in 7.16.0
+.SH RETURN VALUE
+Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
+.SH "SEE ALSO"
+.BR CURLMOPT_MAX_PIPELINE_LENGTH "(3), "
+.BR CURLMOPT_PIPELINING_SITE_BL "(3), "
+.BR CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE "(3), "
+.BR CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE "(3), "
+.BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "
+.BR CURLMOPT_MAXCONNECTS "(3), "
+.BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "