• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>io_context::run_for</title>
5<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
8<link rel="up" href="../io_context.html" title="io_context">
9<link rel="prev" href="run/overload2.html" title="io_context::run (2 of 2 overloads)">
10<link rel="next" href="run_one.html" title="io_context::run_one">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%"><tr>
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
15<td align="center"><a href="../../../../../index.html">Home</a></td>
16<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
19<td align="center"><a href="../../../../../more/index.htm">More</a></td>
20</tr></table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="run/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_context.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run_one.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h4 class="title">
27<a name="boost_asio.reference.io_context.run_for"></a><a class="link" href="run_for.html" title="io_context::run_for">io_context::run_for</a>
28</h4></div></div></div>
29<p>
30          <a class="indexterm" name="boost_asio.indexterm.io_context.run_for"></a>
31Run the <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
32          object's event processing loop for a specified duration.
33        </p>
34<pre class="programlisting">template&lt;
35    typename Rep,
36    typename Period&gt;
37std::size_t run_for(
38    const chrono::duration&lt; Rep, Period &gt; &amp; rel_time);
39</pre>
40<p>
41          The <code class="computeroutput">run_for()</code> function blocks until all work has finished
42          and there are no more handlers to be dispatched, until the <a class="link" href="../io_context.html" title="io_context"><code class="computeroutput">io_context</code></a>
43          has been stopped, or until the specified duration has elapsed.
44        </p>
45<h6>
46<a name="boost_asio.reference.io_context.run_for.h0"></a>
47          <span class="phrase"><a name="boost_asio.reference.io_context.run_for.parameters"></a></span><a class="link" href="run_for.html#boost_asio.reference.io_context.run_for.parameters">Parameters</a>
48        </h6>
49<div class="variablelist">
50<p class="title"><b></b></p>
51<dl class="variablelist">
52<dt><span class="term">rel_time</span></dt>
53<dd><p>
54                The duration for which the call may block.
55              </p></dd>
56</dl>
57</div>
58<h6>
59<a name="boost_asio.reference.io_context.run_for.h1"></a>
60          <span class="phrase"><a name="boost_asio.reference.io_context.run_for.return_value"></a></span><a class="link" href="run_for.html#boost_asio.reference.io_context.run_for.return_value">Return Value</a>
61        </h6>
62<p>
63          The number of handlers that were executed.
64        </p>
65</div>
66<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
67<td align="left"></td>
68<td align="right"><div class="copyright-footer">Copyright © 2003-2020 Christopher M.
69      Kohlhoff<p>
70        Distributed under the Boost Software License, Version 1.0. (See accompanying
71        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>)
72      </p>
73</div></td>
74</tr></table>
75<hr>
76<div class="spirit-nav">
77<a accesskey="p" href="run/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../io_context.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="run_one.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
78</div>
79</body>
80</html>
81