Home Explore Help
Sign In
SoftwareDesign
/
csu3_am335x
8
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Branch: master
Branches Tags
csu3_am335x
/
EVSE
/
GPL
/
curl-7.61.1
/
docs
/
libcurl
/
opts
/
CURLINFO_SPEED_DOWNLOAD.3

CURLINFO_SPEED_DOWNLOAD.3 2.2 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263 
  1. .\" **************************************************************************
    2. 

  2. .\" *                                  _   _ ____  _
    3. 

  3. .\" *  Project                     ___| | | |  _ \| |
    4. 

  4. .\" *                             / __| | | | |_) | |
    5. 

  5. .\" *                            | (__| |_| |  _ <| |___
    6. 

  6. .\" *                             \___|\___/|_| \_\_____|
    7. 

  7. .\" *
    8. 

  8. .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
    9. 

  9. .\" *
    10. 

  10. .\" * This software is licensed as described in the file COPYING, which
    11. 

  11. .\" * you should have received as part of this distribution. The terms
    12. 

  12. .\" * are also available at https://curl.haxx.se/docs/copyright.html.
    13. 

  13. .\" *
    14. 

  14. .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
    15. 

  15. .\" * copies of the Software, and permit persons to whom the Software is
    16. 

  16. .\" * furnished to do so, under the terms of the COPYING file.
    17. 

  17. .\" *
    18. 

  18. .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
    19. 

  19. .\" * KIND, either express or implied.
    20. 

  20. .\" *
    21. 

  21. .\" **************************************************************************
    22. 

  22. .\"
    23. 

  23. .TH CURLINFO_SPEED_DOWNLOAD 3 "June 15, 2017" "libcurl 7.61.1" "curl_easy_getinfo options"
    24. 

  24. 

  25. .SH NAME
    26. 

  26. CURLINFO_SPEED_DOWNLOAD \- get download speed
    27. 

  27. .SH SYNOPSIS
    28. 

  28. #include <curl/curl.h>
    29. 

  29. 

  30. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD, double *speed);
    31. 

  31. .SH DESCRIPTION
    32. 

  32. Pass a pointer to a double to receive the average download speed that curl
    33. 

  33. measured for the complete download. Measured in bytes/second.
    34. 

  34. 

  35. \fICURLINFO_SPEED_DOWNLOAD_T(3)\fP is a newer replacement that returns a more
    36. 

  36. sensible variable type.
    37. 

  37. .SH PROTOCOLS
    38. 

  38. .SH EXAMPLE
    39. 

  39. .nf
    40. 

  40. CURL *curl = curl_easy_init();
    41. 

  41. if(curl) {
    42. 

  42.   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
    43. 

  43. 

  44.   /* Perform the request */
    45. 

  45.   res = curl_easy_perform(curl);
    46. 

  46. 

  47.   if(!res) {
    48. 

  48.     double speed;
    49. 

  49.     res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD, &speed);
    50. 

  50.     if(!res) {
    51. 

  51.       printf("Download speed %.0f bytes/sec\\n", ul);
    52. 

  52.     }
    53. 

  53.   }
    54. 

  54. }
    55. 

  55. .fi
    56. 

  56. .SH AVAILABILITY
    57. 

  57. Added in 7.4.1
    58. 

  58. .SH RETURN VALUE
    59. 

  59. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
    60. 

  60. .SH "SEE ALSO"
    61. 

  61. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
    62. 

  62. .BR CURLINFO_SPEED_UPLOAD "(3), "
    63. 

  63. .BR CURLINFO_SIZE_UPLOAD_T "(3), "
    64.