curl / libcurl / API / curl_easy_setopt / CURLOPT_MAXLIFETIME_CONN

CURLOPT_MAXLIFETIME_CONN explained

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 existing connection to have to be considered for reuse for this request.

libcurl features a 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_MAXLIFETIME_CONN limit prevents libcurl from trying very 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 libcurl 7.80.0

Return value

Returns CURLE_OK.

See also

CURLOPT_TIMEOUT(3), CURLOPT_FORBID_REUSE(3), CURLOPT_FRESH_CONNECT(3), CURLOPT_MAXAGE_CONN(3),

This HTML page was made with roffit.