mirror of
https://github.com/curl/curl.git
synced 2024-12-15 06:40:09 +08:00
230bb3e278
Make all libcurl related options use .nf (no fill) for the SYNOPSIS section - for consistent look. roffit then renders that section using <pre> (monospace font) in html for the website. Extended manpage-syntax (test 1173) with a basic check for it. Closes #8062
67 lines
2.9 KiB
Groff
67 lines
2.9 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLMOPT_MAX_TOTAL_CONNECTIONS 3 "4 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
|
|
.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 will be used as the maximum
|
|
number of simultaneously open connections in total using this multi
|
|
handle. For each new session, libcurl will open a new connection up to the
|
|
limit set by \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP. When the limit is
|
|
reached, the sessions will be pending until there are available
|
|
connections. If \fICURLMOPT_PIPELINING(3)\fP is enabled, libcurl will try to
|
|
use 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 will be queued up waiting for their chance. When
|
|
that happens, the \fICURLOPT_TIMEOUT_MS(3)\fP timeout will be 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
|
|
The default value is 0, which means that there is no limit. It is then simply
|
|
controlled by the number of easy handles added.
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
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 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), " CURLMOPT_MAX_HOST_CONNECTIONS "(3), "
|