| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2014, 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 http://curl.haxx.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 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_TIMEOUT \- set maximum time the request is allowed to take
- .SH SYNOPSIS
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TIMEOUT, long timeout);
- .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 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.
- In unix-like systems, this might cause signals to be used unless
- \fICURLOPT_NOSIGNAL(3)\fP is set.
- 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
- TODO
- .SH AVAILABILITY
- Always
- .SH RETURN VALUE
- Returns CURLE_OK
- .SH "SEE ALSO"
- .BR CURLOPT_TIMEOUT_MS "(3), "
- .BR CURLOPT_CONNECTTIMEOUT "(3), " CURLOPT_LOW_SPEED_LIMIT "(3), "
|
