curl/docs/libcurl/opts/CURLMOPT_MAX_HOST_CONNECTIONS.md
Daniel Stenberg e5000e797f
GHA: add a job scanning for "bad words" in markdown
This means words, phrases or things we have decided not to use - words that
are spelled right according to the dictionary but we want to avoid. In the
name of consistency and better documentation.

Closes #12764
2024-01-24 08:44:34 +01:00

1.8 KiB

c SPDX-License-Identifier Title Section Source See-also
Copyright (C) Daniel Stenberg, <daniel.se>, et al. curl CURLMOPT_MAX_HOST_CONNECTIONS 3 libcurl
CURLMOPT_MAXCONNECTS (3)
CURLMOPT_MAX_TOTAL_CONNECTIONS (3)

NAME

CURLMOPT_MAX_HOST_CONNECTIONS - max number of connections to a single host

SYNOPSIS

#include <curl/curl.h>

CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_HOST_CONNECTIONS,
                            long max);

DESCRIPTION

Pass a long to indicate max. 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 CURLMOPT_MAX_HOST_CONNECTIONS(3). When the limit is reached, new sessions are kept pending until a connection becomes available.

The default max 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 CURLOPT_TIMEOUT_MS(3) 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 CURLOPT_CONNECTTIMEOUT_MS(3) timeout is however treated as a per-connect timeout.

DEFAULT

0

PROTOCOLS

HTTP(S)

EXAMPLE

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);
}

AVAILABILITY

Added in 7.30.0

RETURN VALUE

Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.