Imported Upstream version 7.59.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_PIPEWAIT.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2016, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_PIPEWAIT 3 "May 01, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
24
25 .SH NAME
26 CURLOPT_PIPEWAIT \- wait for pipelining/multiplexing
27 .SH SYNOPSIS
28 #include <curl/curl.h>
29
30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PIPEWAIT, long wait);
31 .SH DESCRIPTION
32 Set \fIwait\fP to 1L to tell libcurl to prefer to wait for a connection to
33 confirm or deny that it can do pipelining or multiplexing before continuing.
34
35 When about to perform a new transfer that allows pipelining or multiplexing,
36 libcurl will check for existing connections to re-use and pipeline on. If no
37 such connection exists it will immediately continue and create a fresh new
38 connection to use.
39
40 By setting this option to 1 - and having \fICURLMOPT_PIPELINING(3)\fP enabled
41 for the multi handle this transfer is associated with - libcurl will instead
42 wait for the connection to reveal if it is possible to pipeline/multiplex on
43 before it continues. This enables libcurl to much better keep the number of
44 connections to a minimum when using pipelining or multiplexing protocols.
45
46 The effect thus becomes that with this option set, libcurl prefers to wait and
47 re-use an existing connection for pipelining rather than the opposite: prefer
48 to open a new connection rather than waiting.
49
50 The waiting time is as long as it takes for the connection to get up and for
51 libcurl to get the necessary response back that informs it about its protocol
52 and support level.
53 .SH DEFAULT
54 0 (off)
55 .SH PROTOCOLS
56 HTTP(S)
57 .SH EXAMPLE
58 .SH AVAILABILITY
59 Added in 7.43.0
60 .SH RETURN VALUE
61 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
62 .SH "SEE ALSO"
63 .BR CURLOPT_FORBID_REUSE "(3), " CURLOPT_FRESH_CONNECT "(3), "
64 .BR CURLMOPT_PIPELINING "(3), " CURLMOPT_MAX_HOST_CONNECTIONS "(3), "