1 .\" **************************************************************************
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
8 .\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
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.
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.
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
21 .\" **************************************************************************
23 .TH CURLOPT_MAX_SEND_SPEED_LARGE 3 "May 30, 2017" "libcurl 7.56.1" "curl_easy_setopt options"
26 CURLOPT_MAX_SEND_SPEED_LARGE \- rate limit data upload speed
29 #include <curl/curl.h>
31 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_SEND_SPEED_LARGE,
34 Pass a curl_off_t as parameter with the \fImaxspeed\fP. If an upload exceeds
35 this speed (counted in bytes per second) the transfer will pause to keep the
36 speed less than or equal to the parameter value. Defaults to unlimited
39 This option doesn't affect transfer speeds done with FILE:// URLs.
46 CURL *curl = curl_easy_init();
49 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
50 /* cap the upload speed to 1000 bytes/sec */
51 curl_easy_setopt(curl, CURLOPT_MAX_SEND_SPEED_LARGE, (curl_off_t)1000);
52 /* (set some upload options as well!) */
53 ret = curl_easy_perform(curl);
59 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
61 .BR CURLOPT_MAX_RECV_SPEED_LARGE "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), "