Return to CURLMOPT_MAX_HOST_CONNECTIONS.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLMOPT_MAX_HOST_CONNECTIONS.3, revision 1.1.1.1

1.1       misho       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_HOST_CONNECTIONS 3 "May 27, 2017" "libcurl 7.70.0" "curl_multi_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLMOPT_MAX_HOST_CONNECTIONS \- set max number of connections to a single host
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLMcode curl_multi_setopt(CURLM *handle, CURLMOPT_MAX_HOST_CONNECTIONS, long max);
                     31: .SH DESCRIPTION
                     32: Pass a long to indicate \fBmax\fP. The set number will be used as the maximum
                     33: amount of simultaneously open connections to a single host (a host being the
                     34: same as a host name + port number pair). For each new session to a host,
                     35: libcurl will open a new connection up to the limit set by
                     36: \fICURLMOPT_MAX_HOST_CONNECTIONS(3)\fP. When the limit is reached, the
                     37: sessions will be pending until a connection becomes available. If
                     38: \fICURLMOPT_PIPELINING(3)\fP is enabled, libcurl will try to pipeline if the
                     39: host is capable of it.
                     40: 
                     41: The default \fBmax\fP value is 0, unlimited.  However, for backwards
                     42: compatibility, setting it to 0 when \fICURLMOPT_PIPELINING(3)\fP is 1 will not
                     43: be treated as unlimited. Instead it will open only 1 connection and try to
                     44: pipeline on it.
                     45: 
                     46: This set limit is also used for proxy connections, and then the proxy is
                     47: considered to be the host for which this limit counts.
                     48: .SH DEFAULT
                     49: 0
                     50: .SH PROTOCOLS
                     51: HTTP(S)
                     52: .SH EXAMPLE
                     53: .nf
                     54: CURLM *m = curl_multi_init();
                     55: /* do no more than 2 connections per host */
                     56: curl_multi_setopt(m, CURLMOPT_MAX_HOST_CONNECTIONS, 2L);
                     57: .fi
                     58: .SH AVAILABILITY
                     59: Added in 7.30.0
                     60: .SH RETURN VALUE
                     61: Returns CURLM_OK if the option is supported, and CURLM_UNKNOWN_OPTION if not.
                     62: .SH "SEE ALSO"
                     63: .BR CURLMOPT_MAXCONNECTS "(3), " CURLMOPT_MAX_TOTAL_CONNECTIONS "(3), "