Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

CURLMOPT_MAXCONNECTS (3)

Name

CURLMOPT_MAXCONNECTS - set size of connection cache

Synopsis

#include <curl/curl.h>

CURLMcode  curl_multi_setopt(CURLM  *handle, CURLMOPT_MAXCONNECTS, long
max);

Description

CURLMOPT_MAXCONNECTS(3)    curl_multi_setopt options   CURLMOPT_MAXCONNECTS(3)



NAME
       CURLMOPT_MAXCONNECTS - set size of connection cache

SYNOPSIS
       #include <curl/curl.h>

       CURLMcode  curl_multi_setopt(CURLM  *handle, CURLMOPT_MAXCONNECTS, long
       max);

DESCRIPTION
       Pass a long indicating the max. The set number will be used as the max-
       imum amount of simultaneously open connections that libcurl may keep in
       its connection cache after  completed  use.  By  default  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 pre-
       vent 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(3) option.

       See CURLMOPT_MAX_TOTAL_CONNECTIONS(3) for limiting the number of active
       connections.


DEFAULT
       See DESCRIPTION

PROTOCOLS
       All

EXAMPLE
       CURLM *m = curl_multi_init();
       /* only keep 10 connections in the cache */
       curl_multi_setopt(m, CURLMOPT_MAXCONNECTS, 10L);

AVAILABILITY
       Added in 7.16.3

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


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


       +---------------+------------------+
       |ATTRIBUTE TYPE | ATTRIBUTE VALUE  |
       +---------------+------------------+
       |Availability   | web/curl         |
       +---------------+------------------+
       |Stability      | Uncommitted      |
       +---------------+------------------+
SEE ALSO
       CURLMOPT_MAX_HOST_CONNECTIONS(3), CURLOPT_MAXCONNECTS(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          CURLMOPT_MAXCONNECTS(3)