Insane_DNS/libraries/asio-1.28.1/doc/asio/reference/io_context/stop.html

53 lines
3.7 KiB
HTML
Raw Normal View History

2023-10-24 21:59:30 -04:00
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>io_context::stop</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="../io_context.html" title="io_context">
<link rel="prev" href="shutdown.html" title="io_context::shutdown">
<link rel="next" href="stopped.html" title="io_context::stopped">
<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="shutdown.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_context.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="stopped.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.io_context.stop"></a><a class="link" href="stop.html" title="io_context::stop">io_context::stop</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.io_context.stop"></a>
Stop the <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput"><span class="identifier">io_context</span></code></a> object's event processing
loop.
</p>
<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">stop</span><span class="special">();</span>
</pre>
<p>
This function does not block, but instead simply signals the <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput"><span class="identifier">io_context</span></code></a> to stop. All invocations
of its <code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>
or <code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>
member functions should return as soon as possible. Subsequent calls to
<code class="computeroutput"><span class="identifier">run</span><span class="special">()</span></code>,
<code class="computeroutput"><span class="identifier">run_one</span><span class="special">()</span></code>,
<code class="computeroutput"><span class="identifier">poll</span><span class="special">()</span></code>
or <code class="computeroutput"><span class="identifier">poll_one</span><span class="special">()</span></code>
will return immediately until <code class="computeroutput"><span class="identifier">restart</span><span class="special">()</span></code> is called.
</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="shutdown.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../io_context.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="stopped.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>