Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_MAXAGE_CONN (3)

Name

CURLOPT_MAXAGE_CONN - max idle time allowed for reusing a connection

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXAGE_CONN, long maxage);

Description

CURLOPT_MAXAGE_CONN(3)     curl_easy_setopt options     CURLOPT_MAXAGE_CONN(3)



NAME
       CURLOPT_MAXAGE_CONN - max idle time allowed for reusing a connection

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXAGE_CONN, long maxage);

DESCRIPTION
       Pass  a  long as parameter containing maxage - the maximum time in sec-
       onds that you allow an existing connection to have been idle to be con-
       sidered for reuse for this request.

       The  "connection  cache" that holds previously used connections. When a
       new request is to be done, it will consider any connection that matches
       for  reuse. The CURLOPT_MAXAGE_CONN(3) limit prevents libcurl from try-
       ing too old connections for reuse, since old connections  have  a  high
       risk  of  not  working  and  thus trying them is a performance loss and
       sometimes service loss due to the difficulties to figure out the situa-
       tion. If a connection is found in the cache that is older than this set
       maxage, it will instead be closed.

DEFAULT
       Default maxage is 118 seconds.

PROTOCOLS
       All

EXAMPLE
       CURL *curl = curl_easy_init();
       if(curl) {
         curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");

         /* only allow 30 seconds idle time */
         curl_easy_setopt(curl, CURLOPT_MAXAGE_CONN, 30L);

         curl_easy_perform(curl);
       }

AVAILABILITY
       Added in 7.65.0

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
       CURLOPT_TIMEOUT(3), CURLOPT_FORBID_REUSE(3),  CURLOPT_FRESH_CONNECT(3),
       CURLOPT_MAXLIFETIME_CONN(3),



NOTES
       Source  code  for open source software components in Oracle Solaris can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This     software     was    built    from    source    available    at
       https://github.com/oracle/solaris-userland.   The  original   community
       source       was       downloaded      from       https://curl.se/down-
       load/curl-7.83.1.tar.bz2.

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



libcurl 7.83.1                 November 26, 2021        CURLOPT_MAXAGE_CONN(3)