curl / libcurl / API / curl_multi_setopt / CURLMINFO_XFERS_PENDING

CURLMINFO_XFERS_PENDING explained

Name

CURLMINFO_XFERS_PENDING - Number of easy handles waiting to start

Synopsis

#include <curl/curl.h>
 
CURLMcode curl_multi_get_offt(CURLM *handle, CURLMINFO_XFERS_PENDING,
                              curl_off_t *pvalue);

Description

The number of current easy handles waiting to start. An added transfer might become pending for various reasons: a connection limit forces it to wait, resolving DNS is not finished or it is not clear if an existing, matching connection may allow multiplexing (HTTP/2 or HTTP/3).

Default

n/a

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURLM *m = curl_multi_init();
  curl_off_t value;
 
  curl_multi_get_offt(m, CURLMINFO_XFERS_PENDING, &value);
}

Availability

Added in curl 8.16.0

Return value

curl_multi_get_offt returns a CURLMcode indicating success or error.

CURLM_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors.