Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_MAX_SEND_SPEED_LARGE.3, revision 1.1.1.1
1.1 misho 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 CURLOPT_MAX_SEND_SPEED_LARGE 3 "May 30, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
24:
25: .SH NAME
26: CURLOPT_MAX_SEND_SPEED_LARGE \- rate limit data upload speed
27: .SH SYNOPSIS
28: .nf
29: #include <curl/curl.h>
30:
31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_SEND_SPEED_LARGE,
32: curl_off_t maxspeed);
33: .SH DESCRIPTION
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
37: speed.
38:
39: This option doesn't affect transfer speeds done with FILE:// URLs.
40: .SH DEFAULT
41: 0, disabled
42: .SH PROTOCOLS
43: All except file://
44: .SH EXAMPLE
45: .nf
46: CURL *curl = curl_easy_init();
47: if(curl) {
48: CURLcode ret;
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);
54: }
55: .fi
56: .SH AVAILABILITY
57: Added in 7.15.5
58: .SH RETURN VALUE
59: Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
60: .SH "SEE ALSO"
61: .BR CURLOPT_MAX_RECV_SPEED_LARGE "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>