docs/libcurl/opts/CURLOPT_TIMEOUT.3

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