| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * 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_TIMEOUT 3 "January 02, 2023" "libcurl 7.88.1" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_TIMEOUT \- maximum time the transfer is allowed to complete
- .SH SYNOPSIS
- .nf
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEOUT, long timeout);
- .fi
- .SH DESCRIPTION
- Pass a long as parameter containing \fItimeout\fP - the maximum time in
- seconds that you allow the libcurl transfer operation to take. Normally, name
- lookups can take a considerable time and limiting operations risk aborting
- perfectly normal operations. This option may cause libcurl to use the SIGALRM
- signal to timeout system calls.
- 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 option puts a hard limit on how long time a request is allowed to
- take, it has limited use in dynamic use cases with varying transfer times. That
- is especially apparent when using the multi interface, which may queue the
- transfer, and that time is included. You are 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 20 seconds */
- curl_easy_setopt(curl, CURLOPT_TIMEOUT, 20L);
- curl_easy_perform(curl);
- }
- .fi
- .SH AVAILABILITY
- Always
- .SH RETURN VALUE
- Returns CURLE_OK. Returns CURLE_BAD_FUNCTION_ARGUMENT if set to a negative
- value or a value that when converted to milliseconds is too large.
- .SH "SEE ALSO"
- .BR CURLOPT_TIMEOUT_MS "(3), "
- .BR CURLOPT_CONNECTTIMEOUT "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), "
|
