73 lines
2.6 KiB
Groff
73 lines
2.6 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is licensed as described in the file COPYING, which
|
||
|
|
.\" * you should have received as part of this distribution. The terms
|
||
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
||
|
|
.\" *
|
||
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
||
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
|
|
.\" * KIND, either express or implied.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_MAXCONNECTS 3 "August 22, 2023" "ibcurl 8.3.0" 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
|
||
|
|
Most
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
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
|
||
|
|
Always
|
||
|
|
.SH RETURN VALUE
|
||
|
|
Returns CURLE_OK
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR CURLMOPT_MAXCONNECTS "(3), " CURLOPT_MAXREDIRS "(3), "
|