| .\" ************************************************************************** |
| .\" * _ _ ____ _ |
| .\" * Project ___| | | | _ \| | |
| .\" * / __| | | | |_) | | |
| .\" * | (__| |_| | _ <| |___ |
| .\" * \___|\___/|_| \_\_____| |
| .\" * |
| .\" * Copyright (C) 1998 - 2020, 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. |
| .\" * |
| .\" ************************************************************************** |
| .\" |
| .TH CURLOPT_TIMEOUT_MS 3 "November 04, 2020" "libcurl 7.78.0" "curl_easy_setopt options" |
| |
| .SH NAME |
| CURLOPT_TIMEOUT_MS \- set maximum time the request is allowed to take |
| .SH SYNOPSIS |
| #include <curl/curl.h> |
| |
| CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEOUT_MS, long timeout); |
| .SH DESCRIPTION |
| Pass a long as parameter containing \fItimeout\fP - the maximum time in |
| milliseconds that you allow the libcurl transfer operation to take. Normally, |
| name lookups can take a considerable time and limiting operations to less than |
| a few minutes risk aborting perfectly normal operations. This option may cause |
| libcurl to use the SIGALRM signal to timeout system calls. |
| |
| If libcurl is built to use the standard system name resolver, that portion of |
| the transfer will still use full-second resolution for timeouts with a minimum |
| timeout allowed of one second. |
| |
| In unix-like systems, this might cause signals to be used unless |
| \fICURLOPT_NOSIGNAL(3)\fP is set. |
| |
| If both \fICURLOPT_TIMEOUT(3)\fP and \fICURLOPT_TIMEOUT_MS(3)\fP are set, the |
| value set last will be used. |
| |
| Since this puts a hard limit for how long time a request is allowed to take, |
| it has limited use in dynamic use cases with varying transfer times. You are |
| then advised to explore \fICURLOPT_LOW_SPEED_LIMIT(3)\fP, |
| \fICURLOPT_LOW_SPEED_TIME(3)\fP or using \fICURLOPT_PROGRESSFUNCTION(3)\fP to |
| implement your own timeout logic. |
| .SH DEFAULT |
| Default timeout is 0 (zero) which means it never times out during transfer. |
| .SH PROTOCOLS |
| All |
| .SH EXAMPLE |
| .nf |
| CURL *curl = curl_easy_init(); |
| if(curl) { |
| curl_easy_setopt(curl, CURLOPT_URL, "https://example.com"); |
| |
| /* complete within 20000 milliseconds */ |
| curl_easy_setopt(curl, CURLOPT_TIMEOUT_MS, 20000L); |
| |
| curl_easy_perform(curl); |
| } |
| .fi |
| .SH AVAILABILITY |
| Always |
| .SH RETURN VALUE |
| Returns CURLE_OK |
| .SH "SEE ALSO" |
| .BR CURLOPT_TIMEOUT "(3), " |
| .BR CURLOPT_CONNECTTIMEOUT "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), " |
