curl / libcurl / API / curl_easy_setopt / CURLOPT_MAXCONNECTS

CURLOPT_MAXCONNECTS explained

Name

CURLOPT_MAXCONNECTS - maximum connection cache size

Synopsis

#include <curl/curl.h>
 
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount);

Description

Pass a long. The set amount is the maximum number of connections that libcurl may keep alive in its connection cache after use. The default is 5, and there is not much point in changing this value unless you are perfectly aware of how this works. This concerns connections using any of the protocols that support persistent connections.

When reaching the maximum limit, curl closes the oldest connection present in the cache to prevent the number of connections from increasing.

If you already have performed transfers with this curl handle, setting a smaller CURLOPT_MAXCONNECTS than before may cause open connections to get closed unnecessarily.

If you add this easy handle to a multi handle, this setting is not acknowledged, and you must instead use curl_multi_setopt and the CURLMOPT_MAXCONNECTS option.

Default

Protocols

This functionality affects all supported protocols

Example

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode ret;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    /* limit the connection cache for this handle to no more than 3 */
    curl_easy_setopt(curl, CURLOPT_MAXCONNECTS, 3L);
    ret = curl_easy_perform(curl);
  }
}

Availability

Added in curl 7.7

Return value

Returns CURLE_OK