curl / libcurl / API / curl_multi_setopt / CURLMOPT_MAX_PIPELINE_LENGTH

CURLMOPT_MAX_PIPELINE_LENGTH explained

Name

CURLMOPT_MAX_PIPELINE_LENGTH - maximum number of requests in a pipeline

Synopsis

#include <curl/curl.h>
 
CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_PIPELINE_LENGTH,
                            long max);

Description

No function since pipelining was removed in 7.62.0.

Pass a long. The set max number is used as the maximum amount of outstanding requests in an HTTP/1.1 pipeline. This option is only used for HTTP/1.1 pipelining, not for HTTP/2 multiplexing.

When this limit is reached, libcurl creates another connection to the same host (see CURLMOPT_MAX_HOST_CONNECTIONS), or queue the request until one

of the pipelines to the host is ready to accept a request. Thus, the total

CURLMOPT_MAX_PIPELINE_LENGTH.

Default

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURLM *m = curl_multi_init();
  /* set a more conservative pipe length */
  curl_multi_setopt(m, CURLMOPT_MAX_PIPELINE_LENGTH, 3L);
}

Availability

Added in curl 7.30.0

Return value

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