| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <[email protected]>, 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_TIMEOUT_MS 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_TIMEOUT_MS \- set maximum time the request is allowed to take |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEOUT_MS, long timeout); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a long as parameter containing \fItimeout\fP - the maximum time in |
| 32 |
milliseconds that you allow the libcurl transfer operation to take. Normally, |
| 33 |
name lookups can take a considerable time and limiting operations to less than |
| 34 |
a few minutes risk aborting perfectly normal operations. This option may cause |
| 35 |
libcurl to use the SIGALRM signal to timeout system calls. |
| 36 |
|
| 37 |
If libcurl is built to use the standard system name resolver, that portion of |
| 38 |
the transfer will still use full-second resolution for timeouts with a minimum |
| 39 |
timeout allowed of one second. |
| 40 |
|
| 41 |
In unix-like systems, this might cause signals to be used unless |
| 42 |
\fICURLOPT_NOSIGNAL(3)\fP is set. |
| 43 |
|
| 44 |
If both \fICURLOPT_TIMEOUT(3)\fP and \fICURLOPT_TIMEOUT_MS(3)\fP are set, the |
| 45 |
value set last will be used. |
| 46 |
|
| 47 |
Since this puts a hard limit for how long time a request is allowed to take, |
| 48 |
it has limited use in dynamic use cases with varying transfer times. You are |
| 49 |
then advised to explore \fICURLOPT_LOW_SPEED_LIMIT(3)\fP, |
| 50 |
\fICURLOPT_LOW_SPEED_TIME(3)\fP or using \fICURLOPT_PROGRESSFUNCTION(3)\fP to |
| 51 |
implement your own timeout logic. |
| 52 |
.SH DEFAULT |
| 53 |
Default timeout is 0 (zero) which means it never times out during transfer. |
| 54 |
.SH PROTOCOLS |
| 55 |
All |
| 56 |
.SH EXAMPLE |
| 57 |
.nf |
| 58 |
CURL *curl = curl_easy_init(); |
| 59 |
if(curl) { |
| 60 |
curl_easy_setopt(curl, CURLOPT_URL, "http://example.com"); |
| 61 |
|
| 62 |
/* complete within 20000 milliseconds */ |
| 63 |
curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, 20000L); |
| 64 |
|
| 65 |
curl_easy_perform(curl); |
| 66 |
} |
| 67 |
.fi |
| 68 |
.SH AVAILABILITY |
| 69 |
Always |
| 70 |
.SH RETURN VALUE |
| 71 |
Returns CURLE_OK |
| 72 |
.SH "SEE ALSO" |
| 73 |
.BR CURLOPT_TIMEOUT "(3), " |
| 74 |
.BR CURLOPT_CONNECTTIMEOUT "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), " |