keep_alive.html
3.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_socket::keep_alive</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../basic_socket.html" title="basic_socket">
<link rel="prev" href="is_open.html" title="basic_socket::is_open">
<link rel="next" href="linger.html" title="basic_socket::linger">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_open.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="linger.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.basic_socket.keep_alive"></a><a class="link" href="keep_alive.html" title="basic_socket::keep_alive">basic_socket::keep_alive</a>
</h4></div></div></div>
<p>
<span class="emphasis"><em>Inherited from socket_base.</em></span>
</p>
<p>
<a class="indexterm" name="asio.indexterm.basic_socket.keep_alive"></a>
Socket option
to send keep-alives.
</p>
<pre class="programlisting">typedef implementation_defined keep_alive;
</pre>
<p>
Implements the SOL_SOCKET/SO_KEEPALIVE socket option.
</p>
<h6>
<a name="asio.reference.basic_socket.keep_alive.h0"></a>
<span><a name="asio.reference.basic_socket.keep_alive.examples"></a></span><a class="link" href="keep_alive.html#asio.reference.basic_socket.keep_alive.examples">Examples</a>
</h6>
<p>
Setting the option:
</p>
<pre class="programlisting">asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::keep_alive option(true);
socket.set_option(option);
</pre>
<p>
Getting the current option value:
</p>
<pre class="programlisting">asio::ip::tcp::socket socket(my_context);
...
asio::socket_base::keep_alive option;
socket.get_option(option);
bool is_set = option.value();
</pre>
<h6>
<a name="asio.reference.basic_socket.keep_alive.h1"></a>
<span><a name="asio.reference.basic_socket.keep_alive.requirements"></a></span><a class="link" href="keep_alive.html#asio.reference.basic_socket.keep_alive.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_socket.hpp</code>
</p>
<p>
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
</p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
Kohlhoff<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="is_open.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_socket.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="linger.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>