mirror of
https://codeberg.org/kiss-community/repo
synced 2024-08-19 12:46:58 +00:00
52 lines
1.6 KiB
Groff
52 lines
1.6 KiB
Groff
.\" generated by cd2nroff 0.1 from CURLOPT_MAX_SEND_SPEED_LARGE.md
|
|
.TH CURLOPT_MAX_SEND_SPEED_LARGE 3 "2024-06-01" libcurl
|
|
.SH NAME
|
|
CURLOPT_MAX_SEND_SPEED_LARGE \- rate limit data upload speed
|
|
.SH SYNOPSIS
|
|
.nf
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_MAX_SEND_SPEED_LARGE,
|
|
curl_off_t maxspeed);
|
|
.fi
|
|
.SH DESCRIPTION
|
|
Pass a curl_off_t as parameter with the \fImaxspeed\fP. If an upload exceeds
|
|
this speed (counted in bytes per second) the transfer pauses to keep the
|
|
average speed less than or equal to the parameter value. Defaults to unlimited
|
|
speed.
|
|
|
|
This is not an exact science. libcurl attempts to keep the average speed below
|
|
the given threshold over a period time.
|
|
|
|
If you set \fImaxspeed\fP to a value lower than
|
|
\fICURLOPT_UPLOAD_BUFFERSIZE(3)\fP, libcurl might "shoot over" the limit on
|
|
its first send and still send off a full buffer.
|
|
|
|
This option does not affect transfer speeds done with FILE:// URLs.
|
|
.SH DEFAULT
|
|
0, disabled
|
|
.SH PROTOCOLS
|
|
All
|
|
.SH EXAMPLE
|
|
.nf
|
|
int main(void)
|
|
{
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
CURLcode ret;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
/* cap the upload speed to 1000 bytes/sec */
|
|
curl_easy_setopt(curl, CURLOPT_MAX_SEND_SPEED_LARGE, (curl_off_t)1000);
|
|
/* (set some upload options as well!) */
|
|
ret = curl_easy_perform(curl);
|
|
}
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in 7.15.5
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
.SH SEE ALSO
|
|
.BR CURLOPT_LOW_SPEED_LIMIT (3),
|
|
.BR CURLOPT_MAX_RECV_SPEED_LARGE (3)
|