docs/libcurl/opts/CURLMOPT_MAX_TOTAL_CONNECTIONS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
   9 .\" *
  10 .\" * This software is licensed as described in the file COPYING, which
  11 .\" * you should have received as part of this distribution. The terms
  12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
  13 .\" *
  14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  15 .\" * copies of the Software, and permit persons to whom the Software is
  16 .\" * furnished to do so, under the terms of the COPYING file.
  17 .\" *
  18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  19 .\" * KIND, either express or implied.
  20 .\" *
  21 .\" **************************************************************************
  22 .\"
  23 .TH CURLMOPT_MAX_TOTAL_CONNECTIONS 3 "May 27, 2017" "libcurl 7.59.0" "curl_multi_setopt options"
  24
  25 .SH NAME
  26 CURLMOPT_MAX_TOTAL_CONNECTIONS \- max simultaneously open connections
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_TOTAL_CONNECTIONS, long amount);
  31 .SH DESCRIPTION
  32 Pass a long for the \fBamount\fP. The set number will be used as the maximum
  33 number of simultaneously open connections in total using this multi
  34 handle. For each new session, libcurl will open a new connection up to the
  35 limit set by \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP. When the limit is
  36 reached, the sessions will be pending until there are available
  37 connections. If \fICURLMOPT_PIPELINING(3)\fP is enabled, libcurl will try to
  38 pipeline or use multiplexing if the host is capable of it.
  39 .SH DEFAULT
  40 The default value is 0, which means that there is no limit. It is then simply
  41 controlled by the number of easy handles added.
  42 .SH PROTOCOLS
  43 All
  44 .SH EXAMPLE
  45 .nf
  46 CURLM *m = curl_multi_init();
  47 /* never do more than 15 connections */
  48 curl_multi_setopt(m, CURLMOPT_MAX_TOTAL_CONNECTIONS, 15L);
  49 .fi
  50 .SH AVAILABILITY
  51 Added in 7.30.0
  52 .SH RETURN VALUE
  53 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  54 .SH "SEE ALSO"
  55 .BR CURLMOPT_MAXCONNECTS "(3), " CURLMOPT_MAX_HOST_CONNECTIONS "(3), "