| 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 CURLMOPT_MAXCONNECTS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLMOPT_MAXCONNECTS \- set size of connection cache |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAXCONNECTS, long max); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a long indicating the \fBmax\fP. The set number will be used as the |
| 32 |
maximum amount of simultaneously open connections that libcurl may keep in its |
| 33 |
connection cache after completed use. By default libcurl will enlarge the size |
| 34 |
for each added easy handle to make it fit 4 times the number of added easy |
| 35 |
handles. |
| 36 |
|
| 37 |
By setting this option, you can prevent the cache size from growing beyond the |
| 38 |
limit set by you. |
| 39 |
|
| 40 |
When the cache is full, curl closes the oldest one in the cache to prevent the |
| 41 |
number of open connections from increasing. |
| 42 |
|
| 43 |
This option is for the multi handle's use only, when using the easy interface |
| 44 |
you should instead use the \fICURLOPT_MAXCONNECTS(3)\fP option. |
| 45 |
|
| 46 |
See \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP for limiting the number of active |
| 47 |
connections. |
| 48 |
|
| 49 |
.SH DEFAULT |
| 50 |
See DESCRIPTION |
| 51 |
.SH PROTOCOLS |
| 52 |
All |
| 53 |
.SH EXAMPLE |
| 54 |
.nf |
| 55 |
CURLM *m = curl_multi_init(); |
| 56 |
/* only keep 10 connections in the cache */ |
| 57 |
curl_multi_setopt(m, CURLMOPT_MAXCONNECTS, 10L); |
| 58 |
.fi |
| 59 |
.SH AVAILABILITY |
| 60 |
Added in 7.16.3 |
| 61 |
.SH RETURN VALUE |
| 62 |
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not. |
| 63 |
.SH "SEE ALSO" |
| 64 |
.BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), " |
| 65 |
.BR CURLOPT_MAXCONNECTS "(3), " |