Insane_DNS/libraries/asio-1.28.1/doc/asio/reference/basic_socket/linger.html

80 lines
5.9 KiB
HTML

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_socket::linger</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="keep_alive.html" title="basic_socket::keep_alive">
<link rel="next" href="local_endpoint.html" title="basic_socket::local_endpoint">
<meta name="viewport" content="width=device-width, initial-scale=1">
</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="keep_alive.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="local_endpoint.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.linger"></a><a class="link" href="linger.html" title="basic_socket::linger">basic_socket::linger</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.linger"></a>
Socket option to specify
whether the socket lingers on close if unsent data is present.
</p>
<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <span class="identifier">linger</span><span class="special">;</span>
</pre>
<p>
Implements the SOL_SOCKET/SO_LINGER socket option.
</p>
<h6>
<a name="asio.reference.basic_socket.linger.h0"></a>
<span><a name="asio.reference.basic_socket.linger.examples"></a></span><a class="link" href="linger.html#asio.reference.basic_socket.linger.examples">Examples</a>
</h6>
<p>
Setting the option:
</p>
<pre class="programlisting"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">my_context</span><span class="special">);</span>
<span class="special">...</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">linger</span> <span class="identifier">option</span><span class="special">(</span><span class="keyword">true</span><span class="special">,</span> <span class="number">30</span><span class="special">);</span>
<span class="identifier">socket</span><span class="special">.</span><span class="identifier">set_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span>
</pre>
<p>
Getting the current option value:
</p>
<pre class="programlisting"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">ip</span><span class="special">::</span><span class="identifier">tcp</span><span class="special">::</span><span class="identifier">socket</span> <span class="identifier">socket</span><span class="special">(</span><span class="identifier">my_context</span><span class="special">);</span>
<span class="special">...</span>
<span class="identifier">asio</span><span class="special">::</span><span class="identifier">socket_base</span><span class="special">::</span><span class="identifier">linger</span> <span class="identifier">option</span><span class="special">;</span>
<span class="identifier">socket</span><span class="special">.</span><span class="identifier">get_option</span><span class="special">(</span><span class="identifier">option</span><span class="special">);</span>
<span class="keyword">bool</span> <span class="identifier">is_set</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">enabled</span><span class="special">();</span>
<span class="keyword">unsigned</span> <span class="keyword">short</span> <span class="identifier">timeout</span> <span class="special">=</span> <span class="identifier">option</span><span class="special">.</span><span class="identifier">timeout</span><span class="special">();</span>
</pre>
<h6>
<a name="asio.reference.basic_socket.linger.h1"></a>
<span><a name="asio.reference.basic_socket.linger.requirements"></a></span><a class="link" href="linger.html#asio.reference.basic_socket.linger.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>
<div class="copyright-footer">Copyright © 2003-2023 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>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="keep_alive.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="local_endpoint.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>