mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
57 lines
2.1 KiB
Groff
57 lines
2.1 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLMOPT_MAX_HOST_CONNECTIONS.md
|
|
.TH CURLMOPT_MAX_HOST_CONNECTIONS 3 "2024-06-01" 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 set number is used as the maximum amount
|
|
of simultaneously open connections to a single host (a host being the same as
|
|
a hostname + port number pair). For each new session to a 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. When that
|
|
happens, the \fICURLOPT_TIMEOUT_MS(3)\fP timeout is 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.
|
|
|
|
Changing this value when there are transfers in progress is possible, and the
|
|
new value is then used the next time checks are performed. Lowering the value
|
|
does however not close down any active transfers, it simply does not allow new
|
|
ones to get made.
|
|
.SH DEFAULT
|
|
0
|
|
.SH PROTOCOLS
|
|
All
|
|
.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 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_TOTAL_CONNECTIONS (3)
|