summaryrefslogtreecommitdiff
path: root/docs/libcurl/opts/CURLOPT_MAXCONNECTS.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2014-06-18 13:18:58 +0200
committerDaniel Stenberg <daniel@haxx.se>2014-06-18 13:18:58 +0200
commitc3954ffb25ee45198ac98f2027ea55cf48ee825e (patch)
tree3b1cbe51f8a4dfbf57a521edf18ebf8de57a8ba9 /docs/libcurl/opts/CURLOPT_MAXCONNECTS.3
parent38bf85fd61df0d7bcab1e1f6bbf6051f7f486bd9 (diff)
downloadcurl-c3954ffb25ee45198ac98f2027ea55cf48ee825e.tar.gz
opts: more man pages
Diffstat (limited to 'docs/libcurl/opts/CURLOPT_MAXCONNECTS.3')
-rw-r--r--docs/libcurl/opts/CURLOPT_MAXCONNECTS.359
1 files changed, 59 insertions, 0 deletions
diff --git a/docs/libcurl/opts/CURLOPT_MAXCONNECTS.3 b/docs/libcurl/opts/CURLOPT_MAXCONNECTS.3
new file mode 100644
index 000000000..2a7d18d11
--- /dev/null
+++ b/docs/libcurl/opts/CURLOPT_MAXCONNECTS.3
@@ -0,0 +1,59 @@
+.\" **************************************************************************
+.\" * _ _ ____ _
+.\" * Project ___| | | | _ \| |
+.\" * / __| | | | |_) | |
+.\" * | (__| |_| | _ <| |___
+.\" * \___|\___/|_| \_\_____|
+.\" *
+.\" * Copyright (C) 1998 - 2014, 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 http://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 CURLOPT_MAXCONNECTS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
+.SH NAME
+CURLOPT_MAXCONNECTS \- set connection cache size
+.SH SYNOPSIS
+#include <curl/curl.h>
+
+CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount);
+.SH DESCRIPTION
+Pass a long. The set number will be the persistent connection cache size. The
+set \fIamount\fP will be the maximum amount of simultaneously open connections
+that libcurl may cache in cache associated with this handle. 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\fP option.
+.SH DEFAULT
+5
+.SH PROTOCOLS
+Most
+.SH EXAMPLE
+TODO
+.SH AVAILABILITY
+Always
+.SH RETURN VALUE
+Returns CURLE_OK
+.SH "SEE ALSO"
+.BR CURLMOPT_MAXCONNECTS "(3), " CURLOPT_MAXREDIRS "(3), "