2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-12-24 00:10:05 -07:00
repo/core/curl/files/CURLOPT_MAXCONNECTS.3
2024-07-29 19:00:04 -05:00

55 lines
1.8 KiB
Groff

.\" generated by cd2nroff 0.1 from CURLOPT_MAXCONNECTS.md
.TH CURLOPT_MAXCONNECTS 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_MAXCONNECTS \- maximum connection cache size
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount);
.fi
.SH DESCRIPTION
Pass a long. The set \fIamount\fP is the maximum number of simultaneously open
persistent connections that libcurl may cache in the pool associated with this
handle. The default is 5, and there is not much point in changing this value
unless you are perfectly aware of how this works. This concerns connections
using any of the protocols that support persistent connections.
When reaching the maximum limit, curl closes the oldest one in the cache to
prevent increasing the number of open connections.
If you already have performed transfers with this curl handle, setting a
smaller \fICURLOPT_MAXCONNECTS(3)\fP than before may cause open connections to
get closed unnecessarily.
If you add this easy handle to a multi handle, this setting is not
acknowledged, and you must instead use \fIcurl_multi_setopt(3)\fP and the
\fICURLMOPT_MAXCONNECTS(3)\fP option.
.SH DEFAULT
5
.SH PROTOCOLS
This functionality affects all supported protocols
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
CURLcode ret;
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
/* limit the connection cache for this handle to no more than 3 */
curl_easy_setopt(curl, CURLOPT_MAXCONNECTS, 3L);
ret = curl_easy_perform(curl);
}
}
.fi
.SH AVAILABILITY
Added in curl 7.7
.SH RETURN VALUE
Returns CURLE_OK
.SH SEE ALSO
.BR CURLMOPT_MAXCONNECTS (3),
.BR CURLMOPT_MAX_HOST_CONNECTIONS (3),
.BR CURLMOPT_MAX_TOTAL_CONNECTIONS (3),
.BR CURLOPT_MAXREDIRS (3)