docs/libcurl/opts/CURLOPT_MAXCONNECTS.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 CURLOPT_MAXCONNECTS 3 "May 30, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_MAXCONNECTS \- maximum connection cache size
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAXCONNECTS, long amount);
  31 .SH DESCRIPTION
  32 Pass a long. The set \fIamount\fP will be the maximum number of simultaneously
  33 open persistent connections that libcurl may cache in the pool associated with
  34 this handle. The default is 5, and there isn't much point in changing this
  35 value unless you are perfectly aware of how this works and changes libcurl's
  36 behaviour. This concerns connections using any of the protocols that support
  37 persistent connections.
  38
  39 When reaching the maximum limit, curl closes the oldest one in the cache to
  40 prevent increasing the number of open connections.
  41
  42 If you already have performed transfers with this curl handle, setting a
  43 smaller \fICURLOPT_MAXCONNECTS(3)\fP than before may cause open connections to
  44 get closed unnecessarily.
  45
  46 If you add this easy handle to a multi handle, this setting is not
  47 acknowledged, and you must instead use \fIcurl_multi_setopt(3)\fP and the
  48 \fICURLMOPT_MAXCONNECTS(3)\fP option.
  49 .SH DEFAULT
  50 5
  51 .SH PROTOCOLS
  52 Most
  53 .SH EXAMPLE
  54 .nf
  55 CURL *curl = curl_easy_init();
  56 if(curl) {
  57   CURLcode ret;
  58   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  59   /* limit the connection cache for this handle to no more than 3 */
  60   curl_easy_setopt(curl, CURLOPT_MAXCONNECTS, 3L);
  61   ret = curl_easy_perform(curl);
  62 }
  63 .fi
  64 .SH AVAILABILITY
  65 Always
  66 .SH RETURN VALUE
  67 Returns CURLE_OK
  68 .SH "SEE ALSO"
  69 .BR CURLMOPT_MAXCONNECTS "(3), " CURLOPT_MAXREDIRS "(3), "