CURLINFO_SPEED_UPLOAD.3 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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_UPLOAD 3 "28 Aug 2015" "libcurl 7.44.0" "curl_easy_getinfo options"
  24. .SH NAME
  25. CURLINFO_SPEED_UPLOAD \- get upload speed
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_SPEED_UPLOAD, double *speed);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a pointer to a double to receive the average upload speed that curl
  33. measured for the complete upload. Measured in bytes/second.
  34. \fICURLINFO_SPEED_UPLOAD_T(3)\fP is a newer replacement that returns a more
  35. sensible variable type.
  36. .SH PROTOCOLS
  37. .SH EXAMPLE
  38. .nf
  39. CURL *curl = curl_easy_init();
  40. if(curl) {
  41. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  42. /* Perform the request */
  43. res = curl_easy_perform(curl);
  44. if(!res) {
  45. double speed;
  46. res = curl_easy_getinfo(curl, CURLINFO_SPEED_UPLOAD, &speed);
  47. if(!res) {
  48. printf("Upload speed %.0f bytes/sec\\n", ul);
  49. }
  50. }
  51. }
  52. .fi
  53. .SH AVAILABILITY
  54. Added in
  55. .SH RETURN VALUE
  56. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  57. .SH "SEE ALSO"
  58. .BR curl_easy_getinfo "(3), " curl_easy_setopt "(3), "
  59. .BR CURLINFO_SPEED_DOWNLOAD "(3), "