CURLOPT_MAXCONNECTS.3: Reworked the description to be less confusing

...and corrected a related typo in curl_easy_setopt.3.
This commit is contained in:
Steve Holme 2014-11-02 10:26:21 +00:00
parent 4bef109689
commit 49ae8f8144
2 changed files with 8 additions and 8 deletions

View File

@ -386,7 +386,7 @@ Cap the upload speed to this. See \fICURLOPT_MAX_SEND_SPEED_LARGE(3)\fP
.IP CURLOPT_MAX_RECV_SPEED_LARGE .IP CURLOPT_MAX_RECV_SPEED_LARGE
Cap the download speed to this. See \fICURLOPT_MAX_RECV_SPEED_LARGE(3)\fP Cap the download speed to this. See \fICURLOPT_MAX_RECV_SPEED_LARGE(3)\fP
.IP CURLOPT_MAXCONNECTS .IP CURLOPT_MAXCONNECTS
Maximum number of connection in the connection pool. See \fICURLOPT_MAXCONNECTS(3)\fP Maximum number of connections in the connection pool. See \fICURLOPT_MAXCONNECTS(3)\fP
.IP CURLOPT_FRESH_CONNECT .IP CURLOPT_FRESH_CONNECT
Use a new connection. \fICURLOPT_FRESH_CONNECT(3)\fP Use a new connection. \fICURLOPT_FRESH_CONNECT(3)\fP
.IP CURLOPT_FORBID_REUSE .IP CURLOPT_FORBID_REUSE

View File

@ -22,18 +22,18 @@
.\" .\"
.TH CURLOPT_MAXCONNECTS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" .TH CURLOPT_MAXCONNECTS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
.SH NAME .SH NAME
CURLOPT_MAXCONNECTS \- set connection cache size CURLOPT_MAXCONNECTS \- maximum connection cache size
.SH SYNOPSIS .SH SYNOPSIS
#include <curl/curl.h> #include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount); CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount);
.SH DESCRIPTION .SH DESCRIPTION
Pass a long. The set number will be the persistent connection cache size. The Pass a long. The set \fIamount\fP will be the maximum number of simultaneously
set \fIamount\fP will be the maximum amount of simultaneously open connections open persistent connections that libcurl may cache in the pool associated with
that libcurl may cache in cache associated with this handle. Default is 5, and this handle. The default is 5, and there isn't much point in changing this
there isn't much point in changing this value unless you are perfectly aware value unless you are perfectly aware of how this works and changes libcurl's
of how this works and changes libcurl's behaviour. This concerns connections behaviour. This concerns connections using any of the protocols that support
using any of the protocols that support persistent connections. persistent connections.
When reaching the maximum limit, curl closes the oldest one in the cache to When reaching the maximum limit, curl closes the oldest one in the cache to
prevent increasing the number of open connections. prevent increasing the number of open connections.