Return to CURLMOPT_MAXCONNECTS.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLMOPT_MAXCONNECTS.3, revision 1.1

1.1     ! misho       1: .\" **************************************************************************
        !             2: .\" *                                  _   _ ____  _
        !             3: .\" *  Project                     ___| | | |  _ \| |
        !             4: .\" *                             / __| | | | |_) | |
        !             5: .\" *                            | (__| |_| |  _ <| |___
        !             6: .\" *                             \___|\___/|_| \_\_____|
        !             7: .\" *
        !             8: .\" * Copyright (C) 1998 - 2020, 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_MAXCONNECTS 3 "March 23, 2020" "libcurl 7.70.0" "curl_multi_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLMOPT_MAXCONNECTS \- set size of connection cache
        !            27: .SH SYNOPSIS
        !            28: #include <curl/curl.h>
        !            29: 
        !            30: CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAXCONNECTS, long max);
        !            31: .SH DESCRIPTION
        !            32: Pass a long indicating the \fBmax\fP. The set number will be used as the
        !            33: maximum amount of simultaneously open connections that libcurl may keep in its
        !            34: connection cache after completed use. By default libcurl will enlarge the size
        !            35: for each added easy handle to make it fit 4 times the number of added easy
        !            36: handles.
        !            37: 
        !            38: By setting this option, you can prevent the cache size from growing beyond the
        !            39: limit set by you.
        !            40: 
        !            41: When the cache is full, curl closes the oldest one in the cache to prevent the
        !            42: number of open connections from increasing.
        !            43: 
        !            44: This option is for the multi handle's use only, when using the easy interface
        !            45: you should instead use the \fICURLOPT_MAXCONNECTS(3)\fP option.
        !            46: 
        !            47: See \fICURLMOPT_MAX_TOTAL_CONNECTIONS(3)\fP for limiting the number of active
        !            48: connections.
        !            49: 
        !            50: .SH DEFAULT
        !            51: See DESCRIPTION
        !            52: .SH PROTOCOLS
        !            53: All
        !            54: .SH EXAMPLE
        !            55: .nf
        !            56: CURLM *m = curl_multi_init();
        !            57: /* only keep 10 connections in the cache */
        !            58: curl_multi_setopt(m, CURLMOPT_MAXCONNECTS, 10L);
        !            59: .fi
        !            60: .SH AVAILABILITY
        !            61: Added in 7.16.3
        !            62: .SH RETURN VALUE
        !            63: Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
        !            64: .SH "SEE ALSO"
        !            65: .BR CURLMOPT_MAX_HOST_CONNECTIONS "(3), "
        !            66: .BR CURLOPT_MAXCONNECTS "(3), "