61 lines
2.3 KiB
Groff
61 lines
2.3 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLMOPT_MAX_HOST_CONNECTIONS.md
|
|
.TH CURLMOPT_MAX_HOST_CONNECTIONS 3 "2025-07-07" libcurl
|
|
.SH NAME
|
|
CURLMOPT_MAX_HOST_CONNECTIONS \- max number of connections to a single host
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_HOST_CONNECTIONS,
|
|
long max);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a long to indicate \fBmax\fP, the maximum amount of simultaneously open
|
|
connections libcurl may hold a single host (a host being the same as a
|
|
hostname + port number pair). For each new transfer to the same host, libcurl
|
|
might open a new connection up to the limit set by
|
|
\fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP. When the limit is reached, new sessions are
|
|
kept pending until a connection becomes available.
|
|
|
|
The default \fBmax\fP value is 0, unlimited. This set limit is also used for
|
|
proxy connections, and then the proxy is considered to be the host for which
|
|
this limit counts.
|
|
|
|
When more transfers are added to the multi handle than what can be performed
|
|
due to the set limit, they are queued up waiting for their chance.
|
|
|
|
While a transfer is queued up internally waiting for a connection, the
|
|
\fICURLOPT_TIMEOUT_MS(3)\fP timeout is counted inclusive of the waiting time,
|
|
meaning that if you set a too narrow timeout the transfer might never even
|
|
start before it times out. The \fICURLOPT_CONNECTTIMEOUT_MS(3)\fP time is also
|
|
similarly still treated as a per\-connect timeout and might expire even before
|
|
making a new connection is permitted.
|
|
|
|
Changing this value while there are transfers in progress is possible. The new
|
|
value is then used the next time checks are performed. Lowering the value does
|
|
not close down any active transfers, it simply does not allow new ones to get
|
|
made.
|
|
.SH DEFAULT
|
|
0
|
|
.SH PROTOCOLS
|
|
This functionality affects all supported protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURLM *m = curl_multi_init();
|
|
/* do no more than 2 connections per host */
|
|
curl_multi_setopt(m, CURLMOPT_MAX_HOST_CONNECTIONS, 2L);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in curl 7.30.0
|
|
.SH RETURN VALUE
|
|
\fIcurl_multi_setopt(3)\fP returns a CURLMcode indicating success or error.
|
|
|
|
CURLM_OK (0) means everything was OK, non\-zero means an error occurred, see
|
|
\fIlibcurl\-errors(3)\fP.
|
|
.SH SEE ALSO
|
|
.BR CURLMOPT_MAXCONNECTS (3),
|
|
.BR CURLMOPT_MAX_TOTAL_CONNECTIONS (3)
|