docs/libcurl/opts/CURLMOPT_PIPELINING.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLMOPT_PIPELINING man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 pre {
   8   overflow: auto;
   9   margin: 0;
  10 }
  11
  12 P.level0, pre.level0 {
  13  padding-left: 2em;
  14 }
  15
  16 P.level1, pre.level1 {
  17  padding-left: 4em;
  18 }
  19
  20 P.level2, pre.level2 {
  21  padding-left: 6em;
  22 }
  23
  24 span.emphasis {
  25  font-style: italic;
  26 }
  27
  28 span.bold {
  29  font-weight: bold;
  30 }
  31
  32 span.manpage {
  33  font-weight: bold;
  34 }
  35
  36 h2.nroffsh {
  37  background-color: #e0e0e0;
  38 }
  39
  40 span.nroffip {
  41  font-weight: bold;
  42  font-size: 120%;
  43  font-family: monospace;
  44 }
  45
  46 p.roffit {
  47  text-align: center;
  48  font-size: 80%;
  49 }
  50 </STYLE>
  51 </head><body>
  52
  53 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  54 <p class="level0">CURLMOPT_PIPELINING - enable HTTP pipelining and multiplexing <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  55 <p class="level0">&#35;include &lt;curl/curl.h&gt;
  56 <p class="level0">CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING, long bitmask); <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  57 <p class="level0">Pass in the <span Class="bold">bitmask</span> parameter to instruct libcurl to enable HTTP pipelining and/or HTTP/2 multiplexing for this multi handle.
  58 <p class="level0">When enabled, libcurl will attempt to use those protocol features when doing parallel requests to the same hosts.
  59 <p class="level0">For pipelining, 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.
  60 <p class="level0">For multiplexing, this means that follow-up requests can re-use an existing connection and send the new request multiplexed over that at the same time as other transfers are already using that single connection.
  61 <p class="level0">There are several other related options that are interesting to tweak and adjust to alter how libcurl spreads out requests on different connections or not etc.
  62 <p class="level0">Before 7.43.0, this option was set to 1 and 0 to enable and disable HTTP/1.1 pipelining.
  63 <p class="level0">Starting in 7.43.0, <span Class="bold">bitmask</span>'s second bit also has a meaning, and you can ask for pipelining and multiplexing independently of each other by toggling the correct bits.
  64 <p class="level0"><a name="CURLPIPENOTHING"></a><span class="nroffip">CURLPIPE_NOTHING (0)</span>
  65 <p class="level1">Default, which means doing no attempts at pipelining or multiplexing.
  66 <p class="level0"><a name="CURLPIPEHTTP1"></a><span class="nroffip">CURLPIPE_HTTP1 (1)</span>
  67 <p class="level1">If this bit is set, libcurl will try to pipeline HTTP/1.1 requests on connections that are already established and in use to hosts.
  68 <p class="level0"><a name="CURLPIPEMULTIPLEX"></a><span class="nroffip">CURLPIPE_MULTIPLEX (2)</span>
  69 <p class="level1">If this bit is set, libcurl will try to multiplex the new transfer over an existing connection if possible. This requires HTTP/2. <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  70 <p class="level0">0 (both pipeline and multiplexing are off) <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  71 <p class="level0">HTTP(S) <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  72 <p class="level0">TODO <a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
  73 <p class="level0">Added in 7.16.0. Multiplex support bit added in 7.43.0. <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
  74 <p class="level0">Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
  75 <p class="level0"><a Class="manpage" href="./CURLMOPT_MAX_PIPELINE_LENGTH.html">CURLMOPT_MAX_PIPELINE_LENGTH</a>, <a Class="manpage" href="./CURLMOPT_PIPELINING_SITE_BL.html">CURLMOPT_PIPELINING_SITE_BL</a>, <a Class="manpage" href="./CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE.html">CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE</a>, <a Class="manpage" href="./CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE.html">CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE</a>, <a Class="manpage" href="./CURLMOPT_MAX_HOST_CONNECTIONS.html">CURLMOPT_MAX_HOST_CONNECTIONS</a>, <a Class="manpage" href="./CURLMOPT_MAXCONNECTS.html">CURLMOPT_MAXCONNECTS</a>, <a Class="manpage" href="./CURLMOPT_MAX_HOST_CONNECTIONS.html">CURLMOPT_MAX_HOST_CONNECTIONS</a><p class="roffit">
  76  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
  77 </body></html>