50 lines
1.9 KiB
Groff
50 lines
1.9 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLMOPT_MAX_TOTAL_CONNECTIONS.md
|
|
.TH CURLMOPT_MAX_TOTAL_CONNECTIONS 3 "2024-09-25" libcurl
|
|
.SH NAME
|
|
CURLMOPT_MAX_TOTAL_CONNECTIONS \- max simultaneously open connections
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_TOTAL_CONNECTIONS,
|
|
long amount);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a long for the \fBamount\fP. The set number is used as the maximum number
|
|
of simultaneously open connections in total using this multi handle. For each
|
|
new session, libcurl might open a new connection up to the limit set by
|
|
\fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP. When the limit is reached, new
|
|
sessions are held pending until there are available connections. If
|
|
\fICURLMOPT_PIPELINING(3)\fP is enabled, libcurl can try multiplexing if the
|
|
host is capable of it.
|
|
|
|
When more transfers are added to the multi handle than what can be performed
|
|
due to the set limit, they get queued up waiting for their chance. When that
|
|
happens, the \fICURLOPT_TIMEOUT_MS(3)\fP timeout is counted inclusive of the
|
|
waiting time, meaning that if you set a too narrow timeout in such a case the
|
|
transfer might never even start before it times out.
|
|
|
|
Even in the queued up situation, the \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP
|
|
timeout is however treated as a per\-connect timeout.
|
|
.SH DEFAULT
|
|
0, which means that there is no limit. It is then simply controlled by the
|
|
number of easy handles added.
|
|
.SH PROTOCOLS
|
|
This functionality affects all supported protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURLM *m = curl_multi_init();
|
|
/* never do more than 15 connections */
|
|
curl_multi_setopt(m, CURLMOPT_MAX_TOTAL_CONNECTIONS, 15L);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in curl 7.30.0
|
|
.SH RETURN VALUE
|
|
Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLMOPT_MAXCONNECTS (3),
|
|
.BR CURLMOPT_MAX_HOST_CONNECTIONS (3)
|