70 lines
2.2 KiB
Groff
70 lines
2.2 KiB
Groff
|
.\" **************************************************************************
|
||
|
|
.\" * _ _ ____ _
|
||
|
|
.\" * Project ___| | | | _ \| |
|
||
|
|
.\" * / __| | | | |_) | |
|
||
|
|
.\" * | (__| |_| | _ <| |___
|
||
|
|
.\" * \___|\___/|_| \_\_____|
|
||
|
|
.\" *
|
||
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is licensed as described in the file COPYING, which
|
||
|
|
.\" * you should have received as part of this distribution. The terms
|
||
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
||
|
|
.\" *
|
||
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
||
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
||
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
||
|
|
.\" *
|
||
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
||
|
|
.\" * KIND, either express or implied.
|
||
|
|
.\" *
|
||
|
|
.\" * SPDX-License-Identifier: curl
|
||
|
|
.\" *
|
||
|
|
.\" **************************************************************************
|
||
|
|
.\"
|
||
|
|
.TH CURLOPT_LOW_SPEED_TIME 3 "17 Jun 2014" libcurl libcurl
|
||
|
|
.SH NAME
|
||
|
|
CURLOPT_LOW_SPEED_TIME \- low speed limit time period
|
||
|
|
.SH SYNOPSIS
|
||
|
|
.nf
|
||
|
|
#include <curl/curl.h>
|
||
|
|
|
||
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_LOW_SPEED_TIME,
|
||
|
|
long speedtime);
|
||
|
|
.fi
|
||
|
|
.SH DESCRIPTION
|
||
|
|
Pass a long as parameter. It contains the time in number seconds that the
|
||
|
|
transfer speed should be below the \fICURLOPT_LOW_SPEED_LIMIT(3)\fP for the
|
||
|
|
library to consider it too slow and abort.
|
||
|
|
.SH DEFAULT
|
||
|
|
0, disabled
|
||
|
|
.SH PROTOCOLS
|
||
|
|
All
|
||
|
|
.SH EXAMPLE
|
||
|
|
.nf
|
||
|
|
int main(void)
|
||
|
|
{
|
||
|
|
CURL *curl = curl_easy_init();
|
||
|
|
if(curl) {
|
||
|
|
CURLcode res;
|
||
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
||
|
|
/* abort if slower than 30 bytes/sec during 60 seconds */
|
||
|
|
curl_easy_setopt(curl, CURLOPT_LOW_SPEED_TIME, 60L);
|
||
|
|
curl_easy_setopt(curl, CURLOPT_LOW_SPEED_LIMIT, 30L);
|
||
|
|
res = curl_easy_perform(curl);
|
||
|
|
if(CURLE_OPERATION_TIMEDOUT == res) {
|
||
|
|
printf("Timeout!\\n");
|
||
|
|
}
|
||
|
|
/* always cleanup */
|
||
|
|
curl_easy_cleanup(curl);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
.fi
|
||
|
|
.SH AVAILABILITY
|
||
|
|
Always
|
||
|
|
.SH RETURN VALUE
|
||
|
|
Returns CURLE_OK
|
||
|
|
.SH "SEE ALSO"
|
||
|
|
.BR CURLOPT_LOW_SPEED_LIMIT (3),
|
||
|
|
.BR CURLOPT_TIMEOUT (3)
|