docs/libcurl/opts/CURLOPT_TCP_KEEPIDLE.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_TCP_KEEPIDLE 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_TCP_KEEPIDLE \- set TCP keep-alive idle time wait
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_KEEPIDLE, long delay);
  30 .SH DESCRIPTION
  31 Pass a long. Sets the \fIdelay\fP, in seconds, that the operating system will
  32 wait while the connection is idle before sending keepalive probes. Not all
  33 operating systems support this option.
  34 .SH DEFAULT
  35 ?
  36 .SH PROTOCOLS
  37 All
  38 .SH EXAMPLE
  39 .nf
  40 CURL *curl = curl_easy_init();
  41 if(curl) {
  42   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  43
  44   /* enable TCP keep-alive for this transfer */
  45   curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);
  46
  47   /* set keep-alive idle time to 120 seconds */
  48   curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);
  49
  50   /* interval time between keep-alive probes: 60 seconds */
  51   curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);
  52
  53   curl_easy_perform(curl);
  54 }
  55 .fi
  56 .SH AVAILABILITY
  57 Added in 7.25.0
  58 .SH RETURN VALUE
  59 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  60 .SH "SEE ALSO"
  61 .BR CURLOPT_TCP_KEEPALIVE "(3), " CURLOPT_TCP_KEEPINTVL "(3), "