diff options
Diffstat (limited to 'docs/libcurl/opts/GNURLOPT_MAXCONNECTS.3')
| -rw-r--r-- | docs/libcurl/opts/GNURLOPT_MAXCONNECTS.3 | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/libcurl/opts/GNURLOPT_MAXCONNECTS.3 b/docs/libcurl/opts/GNURLOPT_MAXCONNECTS.3 new file mode 100644 index 000000000..44efd5143 --- /dev/null +++ b/docs/libcurl/opts/GNURLOPT_MAXCONNECTS.3 @@ -0,0 +1,68 @@ +.\" ************************************************************************** +.\" * _ _ ____ _ +.\" * Project ___| | | | _ \| | +.\" * / __| | | | |_) | | +.\" * | (__| |_| | _ <| |___ +.\" * \___|\___/|_| \_\_____| +.\" * +.\" * Copyright (C) 1998 - 2017, 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.haxx.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. +.\" * +.\" ************************************************************************** +.\" +.TH GNURLOPT_MAXCONNECTS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" +.SH NAME +CURLOPT_MAXCONNECTS \- maximum connection cache size +.SH SYNOPSIS +#include <gnurl/curl.h> + +CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount); +.SH DESCRIPTION +Pass a long. The set \fIamount\fP will be 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 isn't much point in changing this +value unless you are perfectly aware of how this works and changes libcurl's +behaviour. 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), " |