curlmopt_pipelining(3) [mojave man page]

CURLMOPT_PIPELINING(3)					     curl_multi_setopt options					    CURLMOPT_PIPELINING(3)

NAME

       CURLMOPT_PIPELINING - enable HTTP pipelining and multiplexing

SYNOPSIS

       #include <curl/curl.h>

       CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_PIPELINING, long bitmask);

DESCRIPTION

       Pass in the bitmask parameter to instruct libcurl to enable HTTP pipelining and/or HTTP/2 multiplexing for this multi handle.

       When enabled, libcurl will attempt to use those protocol features when doing parallel requests to the same hosts.

       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.

       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.

       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.

       Before 7.43.0, this option was set to 1 and 0 to enable and disable HTTP/1.1 pipelining.

       Starting in 7.43.0, bitmask's second bit also has a meaning, and you can ask for pipelining and multiplexing independently of each other by
       toggling the correct bits.

       CURLPIPE_NOTHING
       Default, which means doing no attempts at pipelining or multiplexing.

       CURLPIPE_HTTP1
	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.

       CURLPIPE_MULTIPLEX
	 If this bit is set, libcurl will try to multiplex the new transfer over an existing connection if possible. This requires HTTP/2.

DEFAULT

       0 (both pipeline and multiplexing are off)

PROTOCOLS

       HTTP(S)

EXAMPLE

       TODO

AVAILABILITY

       Added in 7.16.0. Multiplex support bit added in 7.43.0.

RETURN VALUE

       Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.

SEE ALSO

       CURLMOPT_MAX_PIPELINE_LENGTH(3), 	  CURLMOPT_PIPELINING_SITE_BL(3),	   CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE(3),	     CURL-
       MOPT_CHUNK_LENGTH_PENALTY_SIZE(3), CURLMOPT_MAX_HOST_CONNECTIONS(3), CURLMOPT_MAXCONNECTS(3), CURLMOPT_MAX_HOST_CONNECTIONS(3),

libcurl 7.54.0							September 01, 2016					    CURLMOPT_PIPELINING(3)

curl_multi_setopt(3)						  libcurl Manual					      curl_multi_setopt(3)

NAME

       curl_multi_setopt - set options for a curl multi handle

SYNOPSIS

       #include <curl/curl.h>

       CURLMcode curl_multi_setopt(CURLM * multi_handle, CURLMoption option, param);

DESCRIPTION

       curl_multi_setopt() is used to tell a libcurl multi handle how to behave. By using the appropriate options to curl_multi_setopt(3), you can
       change libcurl's behaviour when using that multi handle.  All options are set with the option followed by the parameter param. That parame-
       ter  can  be  a	long, a function pointer, an object pointer or a curl_off_t type, depending on what the specific option expects. Read this
       manual carefully as bad input values may cause libcurl to behave badly!	You can only set one option in each function call.

OPTIONS

       CURLMOPT_SOCKETFUNCTION
	      Pass a pointer to a function matching the curl_socket_callback  prototype.  The  curl_multi_socket_action(3)  function  informs  the
	      application  about  updates in the socket (file descriptor) status by doing none, one, or multiple calls to the curl_socket_callback
	      given in the param argument. They update the status with changes since the previous time a curl_multi_socket(3) function was called.
	      If  the given callback pointer is NULL, no callback will be called. Set the callback's userp argument with CURLMOPT_SOCKETDATA.  See
	      curl_multi_socket(3) for more callback details.

       CURLMOPT_SOCKETDATA
	      Pass a pointer to whatever you want passed to the curl_socket_callback's forth argument, the userp pointer.  This  is  not  used	by
	      libcurl but only passed-thru as-is. Set the callback pointer with CURLMOPT_SOCKETFUNCTION.

       CURLMOPT_PIPELINING
	      Pass  a long set to 1 to enable or 0 to disable. Enabling pipelining on a multi handle will make it attempt to perform HTTP Pipelin-
	      ing as far as possible for transfers using this handle. 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. (Added in 7.16.0)

       CURLMOPT_TIMERFUNCTION
	      Pass  a  pointer to a function matching the curl_multi_timer_callback prototype.	This function will then be called when the timeout
	      value changes. The timeout value is at what latest time the application should call one of the "performing" functions of	the  multi
	      interface  (curl_multi_socket_action(3)  and  curl_multi_perform(3))  - to allow libcurl to keep timeouts and retries etc to work. A
	      timeout value of -1 means that there is no timeout at all, and 0 means that the timeout is  already  reached.  Libcurl  attempts	to
	      limit  calling this only when the fixed future timeout time actually changes. See also CURLMOPT_TIMERDATA. This callback can be used
	      instead of, or in addition to, curl_multi_timeout(3). (Added in 7.16.0)

       CURLMOPT_TIMERDATA
	      Pass a pointer to whatever you want passed to the curl_multi_timer_callback's third argument, the userp pointer.	This is  not  used
	      by libcurl but only passed-thru as-is. Set the callback pointer with CURLMOPT_TIMERFUNCTION. (Added in 7.16.0)

       CURLMOPT_MAXCONNECTS
	      Pass a long. The set number will be used as the maximum amount of simultaneously open connections that libcurl may cache. Default is
	      10, and libcurl will enlarge the size for each added easy handle to make it fit 4 times the number of added easy handles.

	      By setting this option, you can prevent the cache size from growing beyond the limit set by you.

	      When the cache is full, curl closes the oldest one in the cache to prevent the number of open connections from increasing.

	      This option is for the multi handle's use only, when using the easy interface you should instead use the CURLOPT_MAXCONNECTS option.

	      (Added in 7.16.3)

RETURNS

       The standard CURLMcode for multi interface error codes. Note that it returns a CURLM_UNKNOWN_OPTION if you try setting an option that  this
       version of libcurl doesn't know of.

AVAILABILITY

       This function was added in libcurl 7.15.4.

SEE ALSO

       curl_multi_cleanup(3), curl_multi_init(3), curl_multi_socket(3), curl_multi_info_read(3)

libcurl 7.16.0							    10 Oct 2006 					      curl_multi_setopt(3)