docs/libcurl/opts/CURLINFO_NUM_CONNECTS.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 CURLINFO_NUM_CONNECTS 3 "May 06, 2017" "libcurl 7.59.0" "curl_easy_getinfo options"
  24
  25 .SH NAME
  26 CURLINFO_NUM_CONNECTS \- get number of created connections
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_NUM_CONNECTS, long *nump);
  31 .SH DESCRIPTION
  32 Pass a pointer to a long to receive how many new connections libcurl had to
  33 create to achieve the previous transfer (only the successful connects are
  34 counted).  Combined with \fICURLINFO_REDIRECT_COUNT(3)\fP you are able to know
  35 how many times libcurl successfully reused existing connection(s) or not.  See
  36 the connection options of \fIcurl_easy_setopt(3)\fP to see how libcurl tries
  37 to make persistent connections to save time.
  38 .SH PROTOCOLS
  39 All
  40 .SH EXAMPLE
  41 .nf
  42 CURL *curl = curl_easy_init();
  43 if(curl) {
  44   CURLcode res;
  45   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  46   curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
  47   res = curl_easy_perform(curl);
  48   if(res == CURLE_OK) {
  49     long connects;
  50     res = curl_easy_getinfo(curl, CURLINFO_NUM_CONNECTS, &connects);
  51     if(res)
  52       printf("It needed %d connects\\n", connects);
  53   }
  54   curl_easy_cleanup(curl);
  55 }
  56 .fi
  57 .SH AVAILABILITY
  58 Added in 7.12.3
  59 .SH RETURN VALUE
  60 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  61 .SH "SEE ALSO"
  62 .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "