Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

CURLOPT_MAXLIFETIME_CONN (3)

Name

CURLOPT_MAXLIFETIME_CONN - max lifetime (since creation) allowed for reusing a connection

Synopsis

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXLIFETIME_CONN,
long maxlifetime);

Description

curl_easy_setopt options                           CURLOPT_MAXLIFETIME_CONN(3)



NAME
       CURLOPT_MAXLIFETIME_CONN  -  max  lifetime (since creation) allowed for
       reusing a connection

SYNOPSIS
       #include <curl/curl.h>

       CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXLIFETIME_CONN,
                                 long maxlifetime);

DESCRIPTION
       Pass a long as parameter containing maxlifetime - the maximum  time  in
       seconds, since the creation of the connection, that you allow an exist-
       ing connection to have to be considered for reuse for this request.

       libcurl features a connection cache that holds previously used  connec-
       tions.   When a new request is to be done, it will consider any connec-
       tion that matches for reuse. The CURLOPT_MAXLIFETIME_CONN(3) limit pre-
       vents  libcurl  from  trying too old connections for reuse. This can be
       used for client-side load balancing. If a connection is  found  in  the
       cache  that  is  older  than  this  set maxlifetime, it will instead be
       closed once any in-progress transfers complete.

       If set to 0, this behavior is disabled: all  connections  are  eligible
       for reuse.

DEFAULT
       Default maxlifetime is 0 seconds (i.e., disabled).

PROTOCOLS
       All

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

         /* only allow each connection to be reused for 30 seconds */
         curl_easy_setopt(curl, CURLOPT_MAXLIFETIME_CONN, 30L);

         curl_easy_perform(curl);
       }

AVAILABILITY
       Added in 7.80.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_MAXAGE_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_MAXLIFETIME_CONN(3)