mirror of https://github.com/curl/curl.git synced 2025-01-12 13:55:11 +08:00

Daniel Stenberg e3fe020089

docs/libcurl: generate PROTOCOLS from meta-data

Remove the PROTOCOLS section from the source files completely and
instead generate them based on the header data in the curldown files.

It also generates TLS backend information for options marked for TLS as
protocol.

Closes #13175

2024-03-23 18:13:03 +01:00

1.6 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

curl

CURLOPT_MAXAGE_CONN

libcurl

CURLOPT_FORBID_REUSE (3)

CURLOPT_FRESH_CONNECT (3)

CURLOPT_MAXLIFETIME_CONN (3)

CURLOPT_TIMEOUT (3)

All

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 age);

DESCRIPTION

Pass a long as parameter containing age - the maximum time in seconds allowed for an existing connection to have been idle to be considered for reuse for this request.

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

DEFAULT

Default maximum age is set to 118 seconds.

EXAMPLE

int main(void)
{
  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.

1.6 KiB Raw Blame History