docs/libcurl/opts/CURLMOPT_MAX_TOTAL_CONNECTIONS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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 http://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 "4 Nov 2014" "libcurl 7.39.0" "curl_multi_setopt options"
  24 .SH NAME
  25 CURLMOPT_MAX_TOTAL_CONNECTIONS \- max simultaneously open connections
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_TOTAL_CONNECTIONS, long amount);
  30 .SH DESCRIPTION
  31 Pass a long for the \fBamount\fP. The set number will be used as the maximum
  32 number of simultaneously open connections in total using this multi
  33 handle. For each new session, libcurl will open a new connection up to the
  34 limit set by \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP. When the limit is
  35 reached, the sessions will be pending until there are available
  36 connections. If \fICURLMOPT_PIPELINING(3)\fP is enabled, libcurl will try to
  37 pipeline if the host is capable of it.
  38 .SH DEFAULT
  39 The default value is 0, which means that there is no limit. It is then simply
  40 controlled by the number of easy handles added.
  41 .SH PROTOCOLS
  42 All
  43 .SH EXAMPLE
  44 TODO
  45 .SH AVAILABILITY
  46 Added in 7.30.0
  47 .SH RETURN VALUE
  48 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  49 .SH "SEE ALSO"
  50 .BR CURLMOPT_MAXCONNECTS "(3), " CURLMOPT_MAX_HOST_CONNECTIONS "(3), "