curl/docs/libcurl/opts/CURLMOPT_MAXCONNECTS.md
Daniel Stenberg 8c1d9378ac
curldown: make 'added-in:' a mandatory header field
- generate AVAILABILITY manpage sections automatically - for consistent
  wording

- allows us to double-check against other documumentation (symbols-in-versions
  etc)

- enables proper automation/scripting based on this data

- lots of them were wrong or missing in the manpages

- several of them repeated (sometimes mismatching) backend support info

Add test 1488 to verify "added-in" version numbers against
symbols-in-versions.

Closes #14217
2024-07-18 18:04:09 +02:00

1.7 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol Added-in
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLMOPT_MAXCONNECTS 3 libcurl
CURLMOPT_MAX_HOST_CONNECTIONS (3)
CURLOPT_MAXCONNECTS (3)
All
7.16.3

NAME

CURLMOPT_MAXCONNECTS - size of connection cache

SYNOPSIS

#include <curl/curl.h>

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

DESCRIPTION

Pass a long indicating the max. The set number is used as the maximum amount of simultaneously open connections that libcurl may keep in its connection cache after completed use. By default libcurl enlarges the size for each added easy handle to make it fit 4 times the number of added easy handles.

By setting this option, you can prevent the cache size from growing beyond the limit set by you.

When the cache is full, curl closes the oldest one in the cache to prevent the number of open connections from increasing.

This option is for the multi handle's use only, when using the easy interface you should instead use the CURLOPT_MAXCONNECTS(3) option.

See CURLMOPT_MAX_TOTAL_CONNECTIONS(3) for limiting the number of active connections.

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.

DEFAULT

See DESCRIPTION

EXAMPLE

int main(void)
{
  CURLM *m = curl_multi_init();
  /* only keep 10 connections in the cache */
  curl_multi_setopt(m, CURLMOPT_MAXCONNECTS, 10L);
}

RETURN VALUE

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