Debian Codegraph @

deps/curl/docs/libcurl/opts/CURLOPT_UPKEEP_INTERVAL_MS.3

raw
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <[email protected]>, 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_UPKEEP_INTERVAL_MS 3 "31 Oct 2018" "libcurl 7.62.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_UPKEEP_INTERVAL_MS \- connection upkeep interval
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_UPKEEP_INTERVAL_MS, long upkeep_interval_ms);
30 .SH DESCRIPTION
31 Some protocols have "connection upkeep" mechanisms. These mechanisms usually
32 send some traffic on existing connections in order to keep them alive; this
33 can prevent connections from being closed due to overzealous firewalls, for
34 example.
35
36 The user needs to explicitly call \fIcurl_easy_upkeep(3)\fP in order to
37 perform the upkeep work.
38
39 Currently the only protocol with a connection upkeep mechanism is HTTP/2: when
40 the connection upkeep interval is exceeded and \fIcurl_easy_upkeep(3)\fP
41 is called, an HTTP/2 PING frame is sent on the connection.
42
43 .SH DEFAULT
44 CURL_UPKEEP_INTERVAL_DEFAULT (currently defined as 60000L, which is 60 seconds)
45 .SH EXAMPLE
46 .nf
47 CURL *curl = curl_easy_init();
48 if(curl) {
49 /* Make a connection to an HTTP/2 server. */
50 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
51
52 /* Set the interval to 30000ms / 30s */
53 curl_easy_setopt(curl, CURLOPT_UPKEEP_INTERVAL_MS, 30000L);
54
55 curl_easy_perform(curl);
56
57 /* Perform more work here. */
58
59 /* While the connection is being held open, curl_easy_upkeep() can be
60 called. If curl_easy_upkeep() is called and the time since the last
61 upkeep exceeds the interval, then an HTTP/2 PING is sent. */
62 curl_easy_upkeep(curl);
63
64 /* Perform more work here. */
65
66 /* always cleanup */
67 curl_easy_cleanup(curl);
68 }
69 .fi
70 .SH AVAILABILITY
71 Added in 7.62.0
72 .SH RETURN VALUE
73 Returns CURLE_OK