| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_MAXCONNECTS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_MAXCONNECTS \- maximum connection cache size |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a long. The set \fIamount\fP will be the maximum number of simultaneously |
| 32 |
open persistent connections that libcurl may cache in the pool associated with |
| 33 |
this handle. The default is 5, and there isn't much point in changing this |
| 34 |
value unless you are perfectly aware of how this works and changes libcurl's |
| 35 |
behaviour. This concerns connections using any of the protocols that support |
| 36 |
persistent connections. |
| 37 |
|
| 38 |
When reaching the maximum limit, curl closes the oldest one in the cache to |
| 39 |
prevent increasing the number of open connections. |
| 40 |
|
| 41 |
If you already have performed transfers with this curl handle, setting a |
| 42 |
smaller \fICURLOPT_MAXCONNECTS(3)\fP than before may cause open connections to |
| 43 |
get closed unnecessarily. |
| 44 |
|
| 45 |
If you add this easy handle to a multi handle, this setting is not |
| 46 |
acknowledged, and you must instead use \fIcurl_multi_setopt(3)\fP and the |
| 47 |
\fICURLMOPT_MAXCONNECTS(3)\fP option. |
| 48 |
.SH DEFAULT |
| 49 |
5 |
| 50 |
.SH PROTOCOLS |
| 51 |
Most |
| 52 |
.SH EXAMPLE |
| 53 |
.nf |
| 54 |
CURL *curl = curl_easy_init(); |
| 55 |
if(curl) { |
| 56 |
CURLcode ret; |
| 57 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); |
| 58 |
/* limit the connection cache for this handle to no more than 3 */ |
| 59 |
curl_easy_setopt(curl, CURLOPT_MAXCONNECTS, 3L); |
| 60 |
ret = curl_easy_perform(curl); |
| 61 |
} |
| 62 |
.fi |
| 63 |
.SH AVAILABILITY |
| 64 |
Always |
| 65 |
.SH RETURN VALUE |
| 66 |
Returns CURLE_OK |
| 67 |
.SH "SEE ALSO" |
| 68 |
.BR CURLMOPT_MAXCONNECTS "(3), " CURLOPT_MAXREDIRS "(3), " |