3bcf4fb3efdd16900a1f782b7c896151c4738263
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_TCP_KEEPINTVL.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2  "http://www.w3.org/TR/html4/loose.dtd">
3 <html><head>
4 <title>CURLOPT_TCP_KEEPINTVL man page</title>
5 <meta name="generator" content="roffit">
6 <STYLE type="text/css">
7 pre {
8   overflow: auto;
9   margin: 0;
10 }
11
12 P.level0, pre.level0 {
13  padding-left: 2em;
14 }
15
16 P.level1, pre.level1 {
17  padding-left: 4em;
18 }
19
20 P.level2, pre.level2 {
21  padding-left: 6em;
22 }
23
24 span.emphasis {
25  font-style: italic;
26 }
27
28 span.bold {
29  font-weight: bold;
30 }
31
32 span.manpage {
33  font-weight: bold;
34 }
35
36 h2.nroffsh {
37  background-color: #e0e0e0;
38 }
39
40 span.nroffip {
41  font-weight: bold;
42  font-size: 120%;
43  font-family: monospace;
44 }
45
46 p.roffit {
47  text-align: center;
48  font-size: 80%;
49 }
50 </STYLE>
51 </head><body>
52
53 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
54 <p class="level0">CURLOPT_TCP_KEEPINTVL - set TCP keep-alive interval <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
55 <p class="level0">&#35;include &lt;curl/curl.h&gt; 
56 <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_TCP_KEEPINTVL, long interval); <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
57 <p class="level0">Pass a long. Sets the interval, in seconds, that the operating system will wait between sending keepalive probes. Not all operating systems support this option. (Added in 7.25.0) <a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
58 <p class="level0"><a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
59 <p class="level0"><a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
60 <p class="level0"><pre class="level0">
61 CURL *curl = curl_easy_init();
62 if(curl) {
63 &nbsp; curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
64 &nbsp;
65 &nbsp; /* enable TCP keep-alive for this transfer */
66 &nbsp; curl_easy_setopt(curl, CURLOPT_TCP_KEEPALIVE, 1L);
67 &nbsp;
68 &nbsp; /* keep-alive idle time to 120 seconds */
69 &nbsp; curl_easy_setopt(curl, CURLOPT_TCP_KEEPIDLE, 120L);
70 &nbsp;
71 &nbsp; /* interval time between keep-alive probes: 60 seconds */
72 &nbsp; curl_easy_setopt(curl, CURLOPT_TCP_KEEPINTVL, 60L);
73 &nbsp;
74 &nbsp; curl_easy_perform(curl);
75 }
76 </pre>
77
78 <p class="level0"><a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
79 <p class="level0">Always <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
80 <p class="level0">Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
81 <p class="level0"><a Class="manpage" href="./CURLOPT_TCP_KEEPALIVE.html">CURLOPT_TCP_KEEPALIVE</a>, <a Class="manpage" href="./CURLOPT_TCP_KEEPIDLE.html">CURLOPT_TCP_KEEPIDLE</a><p class="roffit">
82  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
83 </body></html>