docs/libcurl/opts/CURLOPT_TCP_KEEPALIVE.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 https://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_KEEPALIVE 3 "February 03, 2016" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_TCP_KEEPALIVE \- enable TCP keep-alive probing
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_KEEPALIVE, long probe);
  31 .SH DESCRIPTION
  32 Pass a long. If set to 1, TCP keepalive probes will be sent. The delay and
  33 frequency of these probes can be controlled by the
  34 \fICURLOPT_TCP_KEEPIDLE(3)\fP and \fICURLOPT_TCP_KEEPINTVL(3)\fP options,
  35 provided the operating system supports them. Set to 0 (default behavior) to
  36 disable keepalive probes
  37 .SH DEFAULT
  38 0
  39 .SH PROTOCOLS
  40 All
  41 .SH EXAMPLE
  42 .nf
  43 CURL *curl = curl_easy_init();
  44 if(curl) {
  45   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
  46
  47   /* enable TCP keep-alive for this transfer */
  48   curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);
  49
  50   /* keep-alive idle time to 120 seconds */
  51   curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);
  52
  53   /* interval time between keep-alive probes: 60 seconds */
  54   curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);
  55
  56   curl_easy_perform(curl);
  57 }
  58 .fi
  59 .SH AVAILABILITY
  60 Added in 7.25.0
  61 .SH RETURN VALUE
  62 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  63 .SH "SEE ALSO"
  64 .BR CURLOPT_TCP_KEEPIDLE "(3), " CURLOPT_TCP_KEEPINTVL "(3), "