CURLOPT_MAX_SEND_SPEED_LARGE.3 2.6 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2020, 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 CURLOPT_MAX_SEND_SPEED_LARGE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_MAX_SEND_SPEED_LARGE \- rate limit data upload speed
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_SEND_SPEED_LARGE,
  30. curl_off_t maxspeed);
  31. .SH DESCRIPTION
  32. Pass a curl_off_t as parameter with the \fImaxspeed\fP. If an upload exceeds
  33. this speed (counted in bytes per second) the transfer will pause to keep the
  34. speed less than or equal to the parameter value. Defaults to unlimited
  35. speed.
  36. This is not an exact science. libcurl attempts to keep the average speed below
  37. the given threshold over a period time.
  38. If you set \fImaxspeed\fP to a value lower than
  39. \fICURLOPT_UPLOAD_BUFFERSIZE(3)\fP, libcurl might "shoot over" the limit on
  40. its first send and still send off a full buffer.
  41. This option does not affect transfer speeds done with FILE:// URLs.
  42. .SH DEFAULT
  43. 0, disabled
  44. .SH PROTOCOLS
  45. All except file://
  46. .SH EXAMPLE
  47. .nf
  48. CURL *curl = curl_easy_init();
  49. if(curl) {
  50. CURLcode ret;
  51. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  52. /* cap the upload speed to 1000 bytes/sec */
  53. curl_easy_setopt(curl, CURLOPT_MAX_SEND_SPEED_LARGE, (curl_off_t)1000);
  54. /* (set some upload options as well!) */
  55. ret = curl_easy_perform(curl);
  56. }
  57. .fi
  58. .SH AVAILABILITY
  59. Added in 7.15.5
  60. .SH RETURN VALUE
  61. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62. .SH "SEE ALSO"
  63. .BR CURLOPT_MAX_RECV_SPEED_LARGE "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), "