docs/libcurl/opts/CURLMOPT_MAX_HOST_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_HOST_CONNECTIONS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_multi_setopt options"
  24 .SH NAME
  25 CURLMOPT_MAX_HOST_CONNECTIONS \- set max number of connections to a single host
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_HOST_CONNECTIONS, long max);
  30 .SH DESCRIPTION
  31 Pass a long to indicate \fBmax\fP. The set number will be used as the maximum
  32 amount of simultaneously open connections to a single host. For each new
  33 session to a host, libcurl will open a new connection up to the limit set by
  34 \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP. When the limit is reached, the
  35 sessions will be pending until a connection becomes available. If
  36 \fICURLMOPT_PIPELINING(3)\fP is enabled, libcurl will try to pipeline if the
  37 host is capable of it.
  38
  39 The default \fBmax\fP value is 0, unlimited.  However, for backwards
  40 compatibility, setting it to 0 when \fICURLMOPT_PIPELINING(3)\fP is 1 will not
  41 be treated as unlimited. Instead it will open only 1 connection and try to
  42 pipeline on it.
  43 .SH DEFAULT
  44 0
  45 .SH PROTOCOLS
  46 HTTP(S)
  47 .SH EXAMPLE
  48 TODO
  49 .SH AVAILABILITY
  50 Added in 7.30.0
  51 .SH RETURN VALUE
  52 Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
  53 .SH "SEE ALSO"
  54 .BR CURLMOPT_MAXCONNECTS "(3), " CURLMOPT_MAX_TOTAL_CONNECTIONS "(3), "