2014-06-20 06:58:18 +08:00
|
|
|
.\" **************************************************************************
|
|
|
|
|
.\" * _ _ ____ _
|
|
|
|
|
.\" * Project ___| | | | _ \| |
|
|
|
|
|
.\" * / __| | | | |_) | |
|
|
|
|
|
.\" * | (__| |_| | _ <| |___
|
|
|
|
|
.\" * \___|\___/|_| \_\_____|
|
|
|
|
|
.\" *
|
2023-01-02 20:51:48 +08:00
|
|
|
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
2014-06-20 06:58:18 +08:00
|
|
|
.\" *
|
|
|
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
|
|
|
.\" * you should have received as part of this distribution. The terms
|
2020-11-04 21:02:01 +08:00
|
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
2014-06-20 06:58:18 +08:00
|
|
|
.\" *
|
|
|
|
|
.\" * 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
|
2022-05-17 17:16:50 +08:00
|
|
|
.\" *
|
2014-06-20 06:58:18 +08:00
|
|
|
.\" **************************************************************************
|
|
|
|
|
.\"
|
2023-04-26 14:58:35 +08:00
|
|
|
.TH CURLOPT_TCP_KEEPALIVE 3 "19 Jun 2014" libcurl libcurl
|
2014-06-20 06:58:18 +08:00
|
|
|
.SH NAME
|
2021-09-09 04:55:58 +08:00
|
|
|
CURLOPT_TCP_KEEPALIVE \- TCP keep-alive probing
|
2014-06-20 06:58:18 +08:00
|
|
|
.SH SYNOPSIS
|
2021-11-26 21:20:18 +08:00
|
|
|
.nf
|
2014-06-20 06:58:18 +08:00
|
|
|
#include <curl/curl.h>
|
|
|
|
|
|
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_KEEPALIVE, long probe);
|
2021-11-26 21:20:18 +08:00
|
|
|
.fi
|
2014-06-20 06:58:18 +08:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
Pass a long. If set to 1, TCP keepalive probes will be sent. The delay and
|
|
|
|
|
frequency of these probes can be controlled by the
|
|
|
|
|
\fICURLOPT_TCP_KEEPIDLE(3)\fP and \fICURLOPT_TCP_KEEPINTVL(3)\fP options,
|
|
|
|
|
provided the operating system supports them. Set to 0 (default behavior) to
|
|
|
|
|
disable keepalive probes
|
|
|
|
|
.SH DEFAULT
|
|
|
|
|
0
|
|
|
|
|
.SH PROTOCOLS
|
|
|
|
|
All
|
|
|
|
|
.SH EXAMPLE
|
2015-03-17 15:03:46 +08:00
|
|
|
.nf
|
|
|
|
|
CURL *curl = curl_easy_init();
|
|
|
|
|
if(curl) {
|
2020-09-17 05:04:07 +08:00
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
|
2015-03-17 15:03:46 +08:00
|
|
|
|
|
|
|
|
/* enable TCP keep-alive for this transfer */
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);
|
|
|
|
|
|
|
|
|
|
/* keep-alive idle time to 120 seconds */
|
|
|
|
|
curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);
|
|
|
|
|
|
|
|
|
|
/* interval time between keep-alive probes: 60 seconds */
|
2015-05-08 14:26:37 +08:00
|
|
|
curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);
|
2015-03-17 15:03:46 +08:00
|
|
|
|
|
|
|
|
curl_easy_perform(curl);
|
|
|
|
|
}
|
|
|
|
|
.fi
|
2014-06-20 06:58:18 +08:00
|
|
|
.SH AVAILABILITY
|
|
|
|
|
Added in 7.25.0
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
|
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR CURLOPT_TCP_KEEPIDLE "(3), " CURLOPT_TCP_KEEPINTVL "(3), "
|
