CURLINFO_SPEED_UPLOAD.3 2.1 KB

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