Imported Upstream version 7.48.0
[platform/upstream/curl.git] / docs / libcurl / opts / CURLINFO_NUM_CONNECTS.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2015, 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 CURLINFO_NUM_CONNECTS 3 "12 Sep 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
24 .SH NAME
25 CURLINFO_NUM_CONNECTS \- get number of created connections
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_NUM_CONNECTS, long *nump);
30 .SH DESCRIPTION
31 Pass a pointer to a long to receive how many new connections libcurl had to
32 create to achieve the previous transfer (only the successful connects are
33 counted).  Combined with \fICURLINFO_REDIRECT_COUNT(3)\fP you are able to know
34 how many times libcurl successfully reused existing connection(s) or not.  See
35 the connection options of \fIcurl_easy_setopt(3)\fP to see how libcurl tries
36 to make persistent connections to save time.
37 .SH PROTOCOLS
38 All
39 .SH EXAMPLE
40 TODO
41 .SH AVAILABILITY
42 Added in 7.12.3
43 .SH RETURN VALUE
44 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
45 .SH "SEE ALSO"
46 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "