CURLOPT_PIPEWAIT(3)

1CURLOPT_PIPEWAIT(3)        curl_easy_setopt options        CURLOPT_PIPEWAIT(3)
2
3
4

NAME

6       CURLOPT_PIPEWAIT - wait for pipelining/multiplexing
7

SYNOPSIS

9       #include <curl/curl.h>
10
11       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PIPEWAIT, long wait);
12

DESCRIPTION

14       Set  wait  to  1L to tell libcurl to prefer to wait for a connection to
15       confirm or deny that it can do pipelining or multiplexing  before  con‐
16       tinuing.
17
18       When  about  to perform a new transfer that allows pipelining or multi‐
19       plexing, libcurl will check for  existing  connections  to  re-use  and
20       pipeline  on. If no such connection exists it will immediately continue
21       and create a fresh new connection to use.
22
23       By setting this option to 1 - and having CURLMOPT_PIPELINING(3) enabled
24       for  the  multi  handle this transfer is associated with - libcurl will
25       instead wait for the connection to reveal if it is  possible  to  pipe‐
26       line/multiplex  on  before  it  continues. This enables libcurl to much
27       better keep the number of connections to a minimum when using  pipelin‐
28       ing or multiplexing protocols.
29
30       The  effect  thus becomes that with this option set, libcurl prefers to
31       wait and re-use an existing connection for pipelining rather  than  the
32       opposite: prefer to open a new connection rather than waiting.
33
34       The  waiting  time  is as long as it takes for the connection to get up
35       and for libcurl to get the necessary  response  back  that  informs  it
36       about its protocol and support level.
37

DEFAULT

39       0 (off)
40

PROTOCOLS

42       HTTP(S)
43

EXAMPLE

AVAILABILITY

46       Added in 7.43.0
47

RETURN VALUE

49       Returns  CURLE_OK  if the option is supported, and CURLE_UNKNOWN_OPTION
50       if not.
51