CURLINFO_SPEED_DOWNLOAD_T.3 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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.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_SPEED_DOWNLOAD_T 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_SPEED_DOWNLOAD_T \- get download speed
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_DOWNLOAD_T,
  30. curl_off_t *speed);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a pointer to a \fIcurl_off_t\fP to receive the average download speed
  34. that curl measured for the complete download. Measured in bytes/second.
  35. .SH PROTOCOLS
  36. .SH EXAMPLE
  37. .nf
  38. CURL *curl = curl_easy_init();
  39. if(curl) {
  40. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  41. /* Perform the request */
  42. res = curl_easy_perform(curl);
  43. if(!res) {
  44. curl_off_t speed;
  45. res = curl_easy_getinfo(curl, CURLINFO_SPEED_DOWNLOAD_T, &speed);
  46. if(!res) {
  47. printf("Download speed %" CURL_FORMAT_CURL_OFF_T " bytes/sec\\n", speed);
  48. }
  49. }
  50. }
  51. .fi
  52. .SH AVAILABILITY
  53. Added in 7.55.0
  54. .SH RETURN VALUE
  55. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  56. .SH "SEE ALSO"
  57. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  58. .BR CURLINFO_SPEED_UPLOAD "(3), "
  59. .BR CURLINFO_SIZE_UPLOAD_T "(3), "