Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLOPT_MAXCONNECTS (3)

Name

CURLOPT_MAXCONNECTS - maximum connection cache size

Synopsis

#include <curl/curl.h>

CURLcode   curl_easy_setopt(CURL   *handle,  CURLOPT_MAXCONNECTS,  long
amount);

Description

CURLOPT_MAXCONNECTS(3)     curl_easy_setopt options     CURLOPT_MAXCONNECTS(3)



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 will be the maximum  number  of  simultane-
       ously  open  persistent  connections that libcurl may cache in the pool
       associated with this handle. The default is 5,  and  there  isn't  much
       point in changing this value unless you are perfectly aware of how this
       works and changes libcurl's behaviour. This concerns connections  using
       any of the protocols that support persistent connections.

       When  reaching  the  maximum  limit,  curl closes the oldest one in the
       cache to prevent increasing the number of open connections.

       If you already have performed transfers with this curl handle,  setting
       a smaller CURLOPT_MAXCONNECTS(3) 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(3) and the
       CURLMOPT_MAXCONNECTS(3) option.

DEFAULT
       5

PROTOCOLS
       Most

EXAMPLE
       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
       Always

RETURN VALUE
       Returns CURLE_OK


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLMOPT_MAXCONNECTS(3), CURLOPT_MAXREDIRS(3),



NOTES
       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was    downloaded    from     https://github.com/curl/curl/ar-
       chive/curl-7_64_0.zip

       Further information about this software can be found on the open source
       community website at http://curl.haxx.se/.



libcurl 7.37.0                    17 Jun 2014           CURLOPT_MAXCONNECTS(3)