comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_TCP_KEEPALIVE.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
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 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_TCP_KEEPALIVE \- enable TCP keep-alive probing
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_KEEPALIVE, long probe);
30 .SH DESCRIPTION
31 Pass a long. If set to 1, TCP keepalive probes will be sent. The delay and
32 frequency of these probes can be controlled by the
33 \fICURLOPT_TCP_KEEPIDLE(3)\fP and \fICURLOPT_TCP_KEEPINTVL(3)\fP options,
34 provided the operating system supports them. Set to 0 (default behavior) to
35 disable keepalive probes
36 .SH DEFAULT
37 0
38 .SH PROTOCOLS
39 All
40 .SH EXAMPLE
41 .nf
42 CURL *curl = curl_easy_init();
43 if(curl) {
44 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
45
46 /* enable TCP keep-alive for this transfer */
47 curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);
48
49 /* keep-alive idle time to 120 seconds */
50 curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);
51
52 /* interval time between keep-alive probes: 60 seconds */
53 curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);
54
55 curl_easy_perform(curl);
56 }
57 .fi
58 .SH AVAILABILITY
59 Added in 7.25.0
60 .SH RETURN VALUE
61 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
62 .SH "SEE ALSO"
63 .BR CURLOPT_TCP_KEEPIDLE "(3), " CURLOPT_TCP_KEEPINTVL "(3), "