Adds asio library and Storage Module

This commit is contained in:
Suraxius committed 2020-12-01 22:41:04 +01:00
1 parent 79a6ee5779
commit 30439acd43
4869 files changed
+618801 -903

No files matched your search

@@ -0,0 +1,48 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::~basic_waitable_timer</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="wait/overload2.html" title="basic_waitable_timer::wait (2 of 2 overloads)">
<link rel="next" href="../basic_waitable_timer__rebind_executor.html" title="basic_waitable_timer::rebind_executor">
</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="wait/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="../basic_waitable_timer__rebind_executor.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_waitable_timer._basic_waitable_timer"></a><a class="link" href="_basic_waitable_timer.html" title="basic_waitable_timer::~basic_waitable_timer">basic_waitable_timer::~basic_waitable_timer</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer._basic_waitable_timer"></a>
Destroys
the timer.
</p>
<pre class="programlisting">~basic_waitable_timer();
</pre>
<p>
This function destroys the timer, cancelling any outstanding asynchronous
wait operations associated with the timer as if by calling <code class="computeroutput">cancel</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="wait/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="../basic_waitable_timer__rebind_executor.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,91 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::async_wait</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="../basic_waitable_timer.html" title="basic_waitable_timer">
<link rel="next" href="basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
</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="../basic_waitable_timer.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="basic_waitable_timer.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_waitable_timer.async_wait"></a><a class="link" href="async_wait.html" title="basic_waitable_timer::async_wait">basic_waitable_timer::async_wait</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.async_wait"></a>
Start
an asynchronous wait on the timer.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../WaitHandler.html" title="Wait handler requirements">WaitHandler</a> = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>&gt;
<a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type"><span class="emphasis"><em>DEDUCED</em></span></a> async_wait(
WaitHandler &amp;&amp; handler = <a class="link" href="../asynchronous_operations.html#asio.reference.asynchronous_operations.default_completion_tokens"><span class="emphasis"><em>DEFAULT</em></span></a>);
</pre>
<p>
This function may be used to initiate an asynchronous wait against the
timer. It always returns immediately.
</p>
<p>
For each call to <code class="computeroutput">async_wait()</code>, the supplied handler will be
called exactly once. The handler will be called when:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
The timer has expired.
</li>
<li class="listitem">
The timer was cancelled, in which case the handler is passed the error
code <code class="computeroutput">asio::error::operation_aborted</code>.
</li>
</ul></div>
<h6>
<a name="asio.reference.basic_waitable_timer.async_wait.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.async_wait.parameters"></a></span><a class="link" href="async_wait.html#asio.reference.basic_waitable_timer.async_wait.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">handler</span></dt>
<dd>
<p>
The handler to be called when the timer expires. Copies will be made
of the handler as required. The function signature of the handler
must be:
</p>
<pre class="programlisting">void handler(
const asio::error_code&amp; error // Result of operation.
);
</pre>
<p>
Regardless of whether the asynchronous operation completes immediately
or not, the handler will not be invoked from within this function.
On immediate completion, invocation of the handler will be performed
in a manner equivalent to using <a class="link" href="../post.html" title="post"><code class="computeroutput">post</code></a>.
</p>
</dd>
</dl>
</div>
</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="../basic_waitable_timer.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="basic_waitable_timer.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,99 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::basic_waitable_timer</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="async_wait.html" title="basic_waitable_timer::async_wait">
<link rel="next" href="basic_waitable_timer/overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 8 overloads)">
</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="async_wait.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="basic_waitable_timer/overload1.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_waitable_timer.basic_waitable_timer"></a><a class="link" href="basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">basic_waitable_timer::basic_waitable_timer</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.basic_waitable_timer"></a>
Constructor.
</p>
<pre class="programlisting">explicit <a class="link" href="basic_waitable_timer/overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 8 overloads)">basic_waitable_timer</a>(
const executor_type &amp; ex);
<span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 8 overloads)">more...</a></em></span>
template&lt;
typename ExecutionContext&gt;
explicit <a class="link" href="basic_waitable_timer/overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 8 overloads)">basic_waitable_timer</a>(
ExecutionContext &amp; context,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
<span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 8 overloads)">more...</a></em></span>
</pre>
<p>
Constructor to set a particular expiry time as an absolute time.
</p>
<pre class="programlisting"><a class="link" href="basic_waitable_timer/overload3.html" title="basic_waitable_timer::basic_waitable_timer (3 of 8 overloads)">basic_waitable_timer</a>(
const executor_type &amp; ex,
const time_point &amp; expiry_time);
<span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload3.html" title="basic_waitable_timer::basic_waitable_timer (3 of 8 overloads)">more...</a></em></span>
template&lt;
typename ExecutionContext&gt;
explicit <a class="link" href="basic_waitable_timer/overload4.html" title="basic_waitable_timer::basic_waitable_timer (4 of 8 overloads)">basic_waitable_timer</a>(
ExecutionContext &amp; context,
const time_point &amp; expiry_time,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
<span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload4.html" title="basic_waitable_timer::basic_waitable_timer (4 of 8 overloads)">more...</a></em></span>
</pre>
<p>
Constructor to set a particular expiry time relative to now.
</p>
<pre class="programlisting"><a class="link" href="basic_waitable_timer/overload5.html" title="basic_waitable_timer::basic_waitable_timer (5 of 8 overloads)">basic_waitable_timer</a>(
const executor_type &amp; ex,
const duration &amp; expiry_time);
<span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload5.html" title="basic_waitable_timer::basic_waitable_timer (5 of 8 overloads)">more...</a></em></span>
template&lt;
typename ExecutionContext&gt;
explicit <a class="link" href="basic_waitable_timer/overload6.html" title="basic_waitable_timer::basic_waitable_timer (6 of 8 overloads)">basic_waitable_timer</a>(
ExecutionContext &amp; context,
const duration &amp; expiry_time,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
<span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload6.html" title="basic_waitable_timer::basic_waitable_timer (6 of 8 overloads)">more...</a></em></span>
</pre>
<p>
Move-construct a <a class="link" href="../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
from another.
</p>
<pre class="programlisting"><a class="link" href="basic_waitable_timer/overload7.html" title="basic_waitable_timer::basic_waitable_timer (7 of 8 overloads)">basic_waitable_timer</a>(
basic_waitable_timer &amp;&amp; other);
<span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload7.html" title="basic_waitable_timer::basic_waitable_timer (7 of 8 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../Executor1.html" title="Executor requirements">Executor1</a>&gt;
<a class="link" href="basic_waitable_timer/overload8.html" title="basic_waitable_timer::basic_waitable_timer (8 of 8 overloads)">basic_waitable_timer</a>(
basic_waitable_timer&lt; Clock, WaitTraits, Executor1 &gt; &amp;&amp; other,
typename enable_if&lt; is_convertible&lt; Executor1, Executor &gt;::value &gt;::type * = 0);
<span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload8.html" title="basic_waitable_timer::basic_waitable_timer (8 of 8 overloads)">more...</a></em></span>
</pre>
</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="async_wait.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="basic_waitable_timer/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,63 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::basic_waitable_timer (1 of 8 overloads)</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_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
<link rel="prev" href="../basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
<link rel="next" href="overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 8 overloads)">
</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="../basic_waitable_timer.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 8 overloads)">basic_waitable_timer::basic_waitable_timer
(1 of 8 overloads)</a>
</h5></div></div></div>
<p>
Constructor.
</p>
<pre class="programlisting">basic_waitable_timer(
const executor_type &amp; ex);
</pre>
<p>
This constructor creates a timer without setting an expiry time. The
<code class="computeroutput">expires_at()</code> or <code class="computeroutput">expires_after()</code> functions must
be called to set an expiry time before the timer can be waited on.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload1.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ex</span></dt>
<dd><p>
The I/O executor that the timer will use, by default, to dispatch
handlers for any asynchronous operations performed on the timer.
</p></dd>
</dl>
</div>
</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="../basic_waitable_timer.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,67 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::basic_waitable_timer (2 of 8 overloads)</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_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
<link rel="prev" href="overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 8 overloads)">
<link rel="next" href="overload3.html" title="basic_waitable_timer::basic_waitable_timer (3 of 8 overloads)">
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 8 overloads)">basic_waitable_timer::basic_waitable_timer
(2 of 8 overloads)</a>
</h5></div></div></div>
<p>
Constructor.
</p>
<pre class="programlisting">template&lt;
typename ExecutionContext&gt;
basic_waitable_timer(
ExecutionContext &amp; context,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
</pre>
<p>
This constructor creates a timer without setting an expiry time. The
<code class="computeroutput">expires_at()</code> or <code class="computeroutput">expires_after()</code> functions must
be called to set an expiry time before the timer can be waited on.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload2.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">context</span></dt>
<dd><p>
An execution context which provides the I/O executor that the timer
will use, by default, to dispatch handlers for any asynchronous
operations performed on the timer.
</p></dd>
</dl>
</div>
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,68 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::basic_waitable_timer (3 of 8 overloads)</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_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
<link rel="prev" href="overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 8 overloads)">
<link rel="next" href="overload4.html" title="basic_waitable_timer::basic_waitable_timer (4 of 8 overloads)">
</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="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload4.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload3"></a><a class="link" href="overload3.html" title="basic_waitable_timer::basic_waitable_timer (3 of 8 overloads)">basic_waitable_timer::basic_waitable_timer
(3 of 8 overloads)</a>
</h5></div></div></div>
<p>
Constructor to set a particular expiry time as an absolute time.
</p>
<pre class="programlisting">basic_waitable_timer(
const executor_type &amp; ex,
const time_point &amp; expiry_time);
</pre>
<p>
This constructor creates a timer and sets the expiry time.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload3.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload3.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ex</span></dt>
<dd><p>
The I/O executor object that the timer will use, by default, to
dispatch handlers for any asynchronous operations performed on
the timer.
</p></dd>
<dt><span class="term">expiry_time</span></dt>
<dd><p>
The expiry time to be used for the timer, expressed as an absolute
time.
</p></dd>
</dl>
</div>
</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="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload4.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,71 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::basic_waitable_timer (4 of 8 overloads)</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_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
<link rel="prev" href="overload3.html" title="basic_waitable_timer::basic_waitable_timer (3 of 8 overloads)">
<link rel="next" href="overload5.html" title="basic_waitable_timer::basic_waitable_timer (5 of 8 overloads)">
</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="overload3.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload5.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload4"></a><a class="link" href="overload4.html" title="basic_waitable_timer::basic_waitable_timer (4 of 8 overloads)">basic_waitable_timer::basic_waitable_timer
(4 of 8 overloads)</a>
</h5></div></div></div>
<p>
Constructor to set a particular expiry time as an absolute time.
</p>
<pre class="programlisting">template&lt;
typename ExecutionContext&gt;
basic_waitable_timer(
ExecutionContext &amp; context,
const time_point &amp; expiry_time,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
</pre>
<p>
This constructor creates a timer and sets the expiry time.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload4.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload4.parameters"></a></span><a class="link" href="overload4.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload4.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">context</span></dt>
<dd><p>
An execution context which provides the I/O executor that the timer
will use, by default, to dispatch handlers for any asynchronous
operations performed on the timer.
</p></dd>
<dt><span class="term">expiry_time</span></dt>
<dd><p>
The expiry time to be used for the timer, expressed as an absolute
time.
</p></dd>
</dl>
</div>
</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="overload3.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload5.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,66 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::basic_waitable_timer (5 of 8 overloads)</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_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
<link rel="prev" href="overload4.html" title="basic_waitable_timer::basic_waitable_timer (4 of 8 overloads)">
<link rel="next" href="overload6.html" title="basic_waitable_timer::basic_waitable_timer (6 of 8 overloads)">
</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="overload4.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload6.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload5"></a><a class="link" href="overload5.html" title="basic_waitable_timer::basic_waitable_timer (5 of 8 overloads)">basic_waitable_timer::basic_waitable_timer
(5 of 8 overloads)</a>
</h5></div></div></div>
<p>
Constructor to set a particular expiry time relative to now.
</p>
<pre class="programlisting">basic_waitable_timer(
const executor_type &amp; ex,
const duration &amp; expiry_time);
</pre>
<p>
This constructor creates a timer and sets the expiry time.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload5.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload5.parameters"></a></span><a class="link" href="overload5.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload5.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ex</span></dt>
<dd><p>
The I/O executor that the timer will use, by default, to dispatch
handlers for any asynchronous operations performed on the timer.
</p></dd>
<dt><span class="term">expiry_time</span></dt>
<dd><p>
The expiry time to be used for the timer, relative to now.
</p></dd>
</dl>
</div>
</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="overload4.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload6.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,70 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::basic_waitable_timer (6 of 8 overloads)</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_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
<link rel="prev" href="overload5.html" title="basic_waitable_timer::basic_waitable_timer (5 of 8 overloads)">
<link rel="next" href="overload7.html" title="basic_waitable_timer::basic_waitable_timer (7 of 8 overloads)">
</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="overload5.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload7.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload6"></a><a class="link" href="overload6.html" title="basic_waitable_timer::basic_waitable_timer (6 of 8 overloads)">basic_waitable_timer::basic_waitable_timer
(6 of 8 overloads)</a>
</h5></div></div></div>
<p>
Constructor to set a particular expiry time relative to now.
</p>
<pre class="programlisting">template&lt;
typename ExecutionContext&gt;
basic_waitable_timer(
ExecutionContext &amp; context,
const duration &amp; expiry_time,
typename enable_if&lt; is_convertible&lt; ExecutionContext &amp;, execution_context &amp; &gt;::value &gt;::type * = 0);
</pre>
<p>
This constructor creates a timer and sets the expiry time.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload6.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload6.parameters"></a></span><a class="link" href="overload6.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload6.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">context</span></dt>
<dd><p>
An execution context which provides the I/O executor that the timer
will use, by default, to dispatch handlers for any asynchronous
operations performed on the timer.
</p></dd>
<dt><span class="term">expiry_time</span></dt>
<dd><p>
The expiry time to be used for the timer, relative to now.
</p></dd>
</dl>
</div>
</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="overload5.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload7.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,71 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::basic_waitable_timer (7 of 8 overloads)</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_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
<link rel="prev" href="overload6.html" title="basic_waitable_timer::basic_waitable_timer (6 of 8 overloads)">
<link rel="next" href="overload8.html" title="basic_waitable_timer::basic_waitable_timer (8 of 8 overloads)">
</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="overload6.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload8.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload7"></a><a class="link" href="overload7.html" title="basic_waitable_timer::basic_waitable_timer (7 of 8 overloads)">basic_waitable_timer::basic_waitable_timer
(7 of 8 overloads)</a>
</h5></div></div></div>
<p>
Move-construct a <a class="link" href="../../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
from another.
</p>
<pre class="programlisting">basic_waitable_timer(
basic_waitable_timer &amp;&amp; other);
</pre>
<p>
This constructor moves a timer from one object to another.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload7.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload7.parameters"></a></span><a class="link" href="overload7.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload7.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">other</span></dt>
<dd><p>
The other <a class="link" href="../../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
object from which the move will occur.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload7.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload7.remarks"></a></span><a class="link" href="overload7.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload7.remarks">Remarks</a>
</h6>
<p>
Following the move, the moved-from object is in the same state as if
constructed using the <code class="computeroutput">basic_waitable_timer(const executor_type&amp;)</code>
constructor.
</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="overload6.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="overload8.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,74 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::basic_waitable_timer (8 of 8 overloads)</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_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">
<link rel="prev" href="overload7.html" title="basic_waitable_timer::basic_waitable_timer (7 of 8 overloads)">
<link rel="next" href="../cancel.html" title="basic_waitable_timer::cancel">
</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="overload7.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="../cancel.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload8"></a><a class="link" href="overload8.html" title="basic_waitable_timer::basic_waitable_timer (8 of 8 overloads)">basic_waitable_timer::basic_waitable_timer
(8 of 8 overloads)</a>
</h5></div></div></div>
<p>
Move-construct a <a class="link" href="../../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
from another.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../Executor1.html" title="Executor requirements">Executor1</a>&gt;
basic_waitable_timer(
basic_waitable_timer&lt; Clock, WaitTraits, Executor1 &gt; &amp;&amp; other,
typename enable_if&lt; is_convertible&lt; Executor1, Executor &gt;::value &gt;::type * = 0);
</pre>
<p>
This constructor moves a timer from one object to another.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload8.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload8.parameters"></a></span><a class="link" href="overload8.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload8.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">other</span></dt>
<dd><p>
The other <a class="link" href="../../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
object from which the move will occur.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload8.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.basic_waitable_timer.overload8.remarks"></a></span><a class="link" href="overload8.html#asio.reference.basic_waitable_timer.basic_waitable_timer.overload8.remarks">Remarks</a>
</h6>
<p>
Following the move, the moved-from object is in the same state as if
constructed using the <code class="computeroutput">basic_waitable_timer(const executor_type&amp;)</code>
constructor.
</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="overload7.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="../cancel.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,53 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::cancel</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="basic_waitable_timer/overload8.html" title="basic_waitable_timer::basic_waitable_timer (8 of 8 overloads)">
<link rel="next" href="cancel/overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)">
</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="basic_waitable_timer/overload8.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="cancel/overload1.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_waitable_timer.cancel"></a><a class="link" href="cancel.html" title="basic_waitable_timer::cancel">basic_waitable_timer::cancel</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.cancel"></a>
Cancel
any asynchronous operations that are waiting on the timer.
</p>
<pre class="programlisting">std::size_t <a class="link" href="cancel/overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)">cancel</a>();
<span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)">more...</a></em></span>
</pre>
<p>
(Deprecated: Use non-error_code overload.) Cancel any asynchronous operations
that are waiting on the timer.
</p>
<pre class="programlisting">std::size_t <a class="link" href="cancel/overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)">cancel</a>(
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)">more...</a></em></span>
</pre>
</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="basic_waitable_timer/overload8.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="cancel/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,93 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::cancel (1 of 2 overloads)</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="../cancel.html" title="basic_waitable_timer::cancel">
<link rel="prev" href="../cancel.html" title="basic_waitable_timer::cancel">
<link rel="next" href="overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)">
</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="../cancel.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.cancel.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)">basic_waitable_timer::cancel
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Cancel any asynchronous operations that are waiting on the timer.
</p>
<pre class="programlisting">std::size_t cancel();
</pre>
<p>
This function forces the completion of any pending asynchronous wait
operations against the timer. The handler for each cancelled operation
will be invoked with the <code class="computeroutput">asio::error::operation_aborted</code>
error code.
</p>
<p>
Cancelling the timer does not change the expiry time.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel.overload1.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.cancel.overload1.return_value">Return
Value</a>
</h6>
<p>
The number of asynchronous operations that were cancelled.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel.overload1.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.cancel.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel.overload1.h2"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.cancel.overload1.remarks">Remarks</a>
</h6>
<p>
If the timer has already expired when <code class="computeroutput">cancel()</code> is called,
then the handlers for asynchronous wait operations will:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
have already been invoked; or
</li>
<li class="listitem">
have been queued for invocation in the near future.
</li>
</ul></div>
<p>
These handlers can no longer be cancelled, and therefore are passed an
error code that indicates the successful completion of the wait operation.
</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="../cancel.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,95 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::cancel (2 of 2 overloads)</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="../cancel.html" title="basic_waitable_timer::cancel">
<link rel="prev" href="overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)">
<link rel="next" href="../cancel_one.html" title="basic_waitable_timer::cancel_one">
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="../cancel_one.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.cancel.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)">basic_waitable_timer::cancel
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
(Deprecated: Use non-error_code overload.) Cancel any asynchronous operations
that are waiting on the timer.
</p>
<pre class="programlisting">std::size_t cancel(
asio::error_code &amp; ec);
</pre>
<p>
This function forces the completion of any pending asynchronous wait
operations against the timer. The handler for each cancelled operation
will be invoked with the <code class="computeroutput">asio::error::operation_aborted</code>
error code.
</p>
<p>
Cancelling the timer does not change the expiry time.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel.overload2.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.cancel.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel.overload2.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.cancel.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of asynchronous operations that were cancelled.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel.overload2.h2"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.cancel.overload2.remarks">Remarks</a>
</h6>
<p>
If the timer has already expired when <code class="computeroutput">cancel()</code> is called,
then the handlers for asynchronous wait operations will:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
have already been invoked; or
</li>
<li class="listitem">
have been queued for invocation in the near future.
</li>
</ul></div>
<p>
These handlers can no longer be cancelled, and therefore are passed an
error code that indicates the successful completion of the wait operation.
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.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="../cancel_one.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,53 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::cancel_one</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="cancel/overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)">
<link rel="next" href="cancel_one/overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)">
</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="cancel/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="cancel_one/overload1.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_waitable_timer.cancel_one"></a><a class="link" href="cancel_one.html" title="basic_waitable_timer::cancel_one">basic_waitable_timer::cancel_one</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.cancel_one"></a>
Cancels
one asynchronous operation that is waiting on the timer.
</p>
<pre class="programlisting">std::size_t <a class="link" href="cancel_one/overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)">cancel_one</a>();
<span class="emphasis"><em>» <a class="link" href="cancel_one/overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)">more...</a></em></span>
</pre>
<p>
(Deprecated: Use non-error_code overload.) Cancels one asynchronous operation
that is waiting on the timer.
</p>
<pre class="programlisting">std::size_t <a class="link" href="cancel_one/overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)">cancel_one</a>(
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="cancel_one/overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)">more...</a></em></span>
</pre>
</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="cancel/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="cancel_one/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,94 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::cancel_one (1 of 2 overloads)</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="../cancel_one.html" title="basic_waitable_timer::cancel_one">
<link rel="prev" href="../cancel_one.html" title="basic_waitable_timer::cancel_one">
<link rel="next" href="overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)">
</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="../cancel_one.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel_one.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.cancel_one.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)">basic_waitable_timer::cancel_one
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Cancels one asynchronous operation that is waiting on the timer.
</p>
<pre class="programlisting">std::size_t cancel_one();
</pre>
<p>
This function forces the completion of one pending asynchronous wait
operation against the timer. Handlers are cancelled in FIFO order. The
handler for the cancelled operation will be invoked with the <code class="computeroutput">asio::error::operation_aborted</code>
error code.
</p>
<p>
Cancelling the timer does not change the expiry time.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel_one.overload1.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel_one.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.cancel_one.overload1.return_value">Return
Value</a>
</h6>
<p>
The number of asynchronous operations that were cancelled. That is, either
0 or 1.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel_one.overload1.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel_one.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.cancel_one.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel_one.overload1.h2"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel_one.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.cancel_one.overload1.remarks">Remarks</a>
</h6>
<p>
If the timer has already expired when <code class="computeroutput">cancel_one()</code> is called,
then the handlers for asynchronous wait operations will:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
have already been invoked; or
</li>
<li class="listitem">
have been queued for invocation in the near future.
</li>
</ul></div>
<p>
These handlers can no longer be cancelled, and therefore are passed an
error code that indicates the successful completion of the wait operation.
</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="../cancel_one.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel_one.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,96 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::cancel_one (2 of 2 overloads)</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="../cancel_one.html" title="basic_waitable_timer::cancel_one">
<link rel="prev" href="overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)">
<link rel="next" href="../clock_type.html" title="basic_waitable_timer::clock_type">
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel_one.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="../clock_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.cancel_one.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)">basic_waitable_timer::cancel_one
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
(Deprecated: Use non-error_code overload.) Cancels one asynchronous operation
that is waiting on the timer.
</p>
<pre class="programlisting">std::size_t cancel_one(
asio::error_code &amp; ec);
</pre>
<p>
This function forces the completion of one pending asynchronous wait
operation against the timer. Handlers are cancelled in FIFO order. The
handler for the cancelled operation will be invoked with the <code class="computeroutput">asio::error::operation_aborted</code>
error code.
</p>
<p>
Cancelling the timer does not change the expiry time.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel_one.overload2.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel_one.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.cancel_one.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel_one.overload2.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel_one.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.cancel_one.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of asynchronous operations that were cancelled. That is, either
0 or 1.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.cancel_one.overload2.h2"></a>
<span><a name="asio.reference.basic_waitable_timer.cancel_one.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.cancel_one.overload2.remarks">Remarks</a>
</h6>
<p>
If the timer has already expired when <code class="computeroutput">cancel_one()</code> is called,
then the handlers for asynchronous wait operations will:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
have already been invoked; or
</li>
<li class="listitem">
have been queued for invocation in the near future.
</li>
</ul></div>
<p>
These handlers can no longer be cancelled, and therefore are passed an
error code that indicates the successful completion of the wait operation.
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../cancel_one.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="../clock_type.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::clock_type</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="cancel_one/overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)">
<link rel="next" href="duration.html" title="basic_waitable_timer::duration">
</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="cancel_one/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="duration.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_waitable_timer.clock_type"></a><a class="link" href="clock_type.html" title="basic_waitable_timer::clock_type">basic_waitable_timer::clock_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.clock_type"></a>
The
clock type.
</p>
<pre class="programlisting">typedef Clock clock_type;
</pre>
<h6>
<a name="asio.reference.basic_waitable_timer.clock_type.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.clock_type.requirements"></a></span><a class="link" href="clock_type.html#asio.reference.basic_waitable_timer.clock_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_waitable_timer.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="cancel_one/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="duration.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::duration</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="clock_type.html" title="basic_waitable_timer::clock_type">
<link rel="next" href="executor_type.html" title="basic_waitable_timer::executor_type">
</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="clock_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="executor_type.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_waitable_timer.duration"></a><a class="link" href="duration.html" title="basic_waitable_timer::duration">basic_waitable_timer::duration</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.duration"></a>
The
duration type of the clock.
</p>
<pre class="programlisting">typedef clock_type::duration duration;
</pre>
<h6>
<a name="asio.reference.basic_waitable_timer.duration.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.duration.requirements"></a></span><a class="link" href="duration.html#asio.reference.basic_waitable_timer.duration.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_waitable_timer.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="clock_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="executor_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::executor_type</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="duration.html" title="basic_waitable_timer::duration">
<link rel="next" href="expires_after.html" title="basic_waitable_timer::expires_after">
</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="duration.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="expires_after.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_waitable_timer.executor_type"></a><a class="link" href="executor_type.html" title="basic_waitable_timer::executor_type">basic_waitable_timer::executor_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.executor_type"></a>
The
type of the executor associated with the object.
</p>
<pre class="programlisting">typedef Executor executor_type;
</pre>
<h6>
<a name="asio.reference.basic_waitable_timer.executor_type.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.executor_type.requirements"></a></span><a class="link" href="executor_type.html#asio.reference.basic_waitable_timer.executor_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_waitable_timer.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="duration.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="expires_after.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,104 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expires_after</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="executor_type.html" title="basic_waitable_timer::executor_type">
<link rel="next" href="expires_at.html" title="basic_waitable_timer::expires_at">
</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="executor_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="expires_at.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_waitable_timer.expires_after"></a><a class="link" href="expires_after.html" title="basic_waitable_timer::expires_after">basic_waitable_timer::expires_after</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.expires_after"></a>
Set
the timer's expiry time relative to now.
</p>
<pre class="programlisting">std::size_t expires_after(
const duration &amp; expiry_time);
</pre>
<p>
This function sets the expiry time. Any pending asynchronous wait operations
will be cancelled. The handler for each cancelled operation will be invoked
with the <code class="computeroutput">asio::error::operation_aborted</code> error code.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_after.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_after.parameters"></a></span><a class="link" href="expires_after.html#asio.reference.basic_waitable_timer.expires_after.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">expiry_time</span></dt>
<dd><p>
The expiry time to be used for the timer.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_after.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_after.return_value"></a></span><a class="link" href="expires_after.html#asio.reference.basic_waitable_timer.expires_after.return_value">Return
Value</a>
</h6>
<p>
The number of asynchronous operations that were cancelled.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_after.h2"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_after.exceptions"></a></span><a class="link" href="expires_after.html#asio.reference.basic_waitable_timer.expires_after.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_after.h3"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_after.remarks"></a></span><a class="link" href="expires_after.html#asio.reference.basic_waitable_timer.expires_after.remarks">Remarks</a>
</h6>
<p>
If the timer has already expired when <code class="computeroutput">expires_after()</code> is called,
then the handlers for asynchronous wait operations will:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
have already been invoked; or
</li>
<li class="listitem">
have been queued for invocation in the near future.
</li>
</ul></div>
<p>
These handlers can no longer be cancelled, and therefore are passed an
error code that indicates the successful completion of the wait operation.
</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="executor_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="expires_at.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,62 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expires_at</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="expires_after.html" title="basic_waitable_timer::expires_after">
<link rel="next" href="expires_at/overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)">
</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="expires_after.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="expires_at/overload1.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_waitable_timer.expires_at"></a><a class="link" href="expires_at.html" title="basic_waitable_timer::expires_at">basic_waitable_timer::expires_at</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.expires_at"></a>
(Deprecated:
Use <code class="computeroutput">expiry()</code>.) Get the timer's expiry time as an absolute
time.
</p>
<pre class="programlisting">time_point <a class="link" href="expires_at/overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)">expires_at</a>() const;
<span class="emphasis"><em>» <a class="link" href="expires_at/overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)">more...</a></em></span>
</pre>
<p>
Set the timer's expiry time as an absolute time.
</p>
<pre class="programlisting">std::size_t <a class="link" href="expires_at/overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)">expires_at</a>(
const time_point &amp; expiry_time);
<span class="emphasis"><em>» <a class="link" href="expires_at/overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)">more...</a></em></span>
</pre>
<p>
(Deprecated: Use non-error_code overload.) Set the timer's expiry time
as an absolute time.
</p>
<pre class="programlisting">std::size_t <a class="link" href="expires_at/overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)">expires_at</a>(
const time_point &amp; expiry_time,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="expires_at/overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)">more...</a></em></span>
</pre>
</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="expires_after.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="expires_at/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,48 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expires_at (1 of 3 overloads)</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="../expires_at.html" title="basic_waitable_timer::expires_at">
<link rel="prev" href="../expires_at.html" title="basic_waitable_timer::expires_at">
<link rel="next" href="overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)">
</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="../expires_at.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.expires_at.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)">basic_waitable_timer::expires_at
(1 of 3 overloads)</a>
</h5></div></div></div>
<p>
(Deprecated: Use <code class="computeroutput">expiry()</code>.) Get the timer's expiry time
as an absolute time.
</p>
<pre class="programlisting">time_point expires_at() const;
</pre>
<p>
This function may be used to obtain the timer's current expiry time.
Whether the timer has expired or not does not affect this value.
</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="../expires_at.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,103 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expires_at (2 of 3 overloads)</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="../expires_at.html" title="basic_waitable_timer::expires_at">
<link rel="prev" href="overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)">
<link rel="next" href="overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)">
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.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="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.expires_at.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)">basic_waitable_timer::expires_at
(2 of 3 overloads)</a>
</h5></div></div></div>
<p>
Set the timer's expiry time as an absolute time.
</p>
<pre class="programlisting">std::size_t expires_at(
const time_point &amp; expiry_time);
</pre>
<p>
This function sets the expiry time. Any pending asynchronous wait operations
will be cancelled. The handler for each cancelled operation will be invoked
with the <code class="computeroutput">asio::error::operation_aborted</code> error code.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_at.overload2.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_at.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.expires_at.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">expiry_time</span></dt>
<dd><p>
The expiry time to be used for the timer.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_at.overload2.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_at.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.expires_at.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of asynchronous operations that were cancelled.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_at.overload2.h2"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_at.overload2.exceptions"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.expires_at.overload2.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_at.overload2.h3"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_at.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.expires_at.overload2.remarks">Remarks</a>
</h6>
<p>
If the timer has already expired when <code class="computeroutput">expires_at()</code> is called,
then the handlers for asynchronous wait operations will:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
have already been invoked; or
</li>
<li class="listitem">
have been queued for invocation in the near future.
</li>
</ul></div>
<p>
These handlers can no longer be cancelled, and therefore are passed an
error code that indicates the successful completion of the wait operation.
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.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="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,96 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expires_at (3 of 3 overloads)</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="../expires_at.html" title="basic_waitable_timer::expires_at">
<link rel="prev" href="overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)">
<link rel="next" href="../expires_from_now.html" title="basic_waitable_timer::expires_from_now">
</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="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.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="../expires_from_now.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.expires_at.overload3"></a><a class="link" href="overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)">basic_waitable_timer::expires_at
(3 of 3 overloads)</a>
</h5></div></div></div>
<p>
(Deprecated: Use non-error_code overload.) Set the timer's expiry time
as an absolute time.
</p>
<pre class="programlisting">std::size_t expires_at(
const time_point &amp; expiry_time,
asio::error_code &amp; ec);
</pre>
<p>
This function sets the expiry time. Any pending asynchronous wait operations
will be cancelled. The handler for each cancelled operation will be invoked
with the <code class="computeroutput">asio::error::operation_aborted</code> error code.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_at.overload3.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_at.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.basic_waitable_timer.expires_at.overload3.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">expiry_time</span></dt>
<dd><p>
The expiry time to be used for the timer.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_at.overload3.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_at.overload3.return_value"></a></span><a class="link" href="overload3.html#asio.reference.basic_waitable_timer.expires_at.overload3.return_value">Return
Value</a>
</h6>
<p>
The number of asynchronous operations that were cancelled.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_at.overload3.h2"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_at.overload3.remarks"></a></span><a class="link" href="overload3.html#asio.reference.basic_waitable_timer.expires_at.overload3.remarks">Remarks</a>
</h6>
<p>
If the timer has already expired when <code class="computeroutput">expires_at()</code> is called,
then the handlers for asynchronous wait operations will:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
have already been invoked; or
</li>
<li class="listitem">
have been queued for invocation in the near future.
</li>
</ul></div>
<p>
These handlers can no longer be cancelled, and therefore are passed an
error code that indicates the successful completion of the wait operation.
</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="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.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="../expires_from_now.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,58 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expires_from_now</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="expires_at/overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)">
<link rel="next" href="expires_from_now/overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)">
</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="expires_at/overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="expires_from_now/overload1.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_waitable_timer.expires_from_now"></a><a class="link" href="expires_from_now.html" title="basic_waitable_timer::expires_from_now">basic_waitable_timer::expires_from_now</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.expires_from_now"></a>
(Deprecated:
Use <code class="computeroutput">expiry()</code>.) Get the timer's expiry time relative to now.
</p>
<pre class="programlisting">duration <a class="link" href="expires_from_now/overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)">expires_from_now</a>() const;
<span class="emphasis"><em>» <a class="link" href="expires_from_now/overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)">more...</a></em></span>
</pre>
<p>
(Deprecated: Use <code class="computeroutput">expires_after()</code>.) Set the timer's expiry
time relative to now.
</p>
<pre class="programlisting">std::size_t <a class="link" href="expires_from_now/overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)">expires_from_now</a>(
const duration &amp; expiry_time);
<span class="emphasis"><em>» <a class="link" href="expires_from_now/overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)">more...</a></em></span>
std::size_t <a class="link" href="expires_from_now/overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)">expires_from_now</a>(
const duration &amp; expiry_time,
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="expires_from_now/overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)">more...</a></em></span>
</pre>
</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="expires_at/overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="expires_from_now/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,48 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expires_from_now (1 of 3 overloads)</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="../expires_from_now.html" title="basic_waitable_timer::expires_from_now">
<link rel="prev" href="../expires_from_now.html" title="basic_waitable_timer::expires_from_now">
<link rel="next" href="overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)">
</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="../expires_from_now.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)">basic_waitable_timer::expires_from_now
(1 of 3 overloads)</a>
</h5></div></div></div>
<p>
(Deprecated: Use <code class="computeroutput">expiry()</code>.) Get the timer's expiry time
relative to now.
</p>
<pre class="programlisting">duration expires_from_now() const;
</pre>
<p>
This function may be used to obtain the timer's current expiry time.
Whether the timer has expired or not does not affect this value.
</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="../expires_from_now.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,104 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expires_from_now (2 of 3 overloads)</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="../expires_from_now.html" title="basic_waitable_timer::expires_from_now">
<link rel="prev" href="overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)">
<link rel="next" href="overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)">
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.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="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)">basic_waitable_timer::expires_from_now
(2 of 3 overloads)</a>
</h5></div></div></div>
<p>
(Deprecated: Use <code class="computeroutput">expires_after()</code>.) Set the timer's expiry
time relative to now.
</p>
<pre class="programlisting">std::size_t expires_from_now(
const duration &amp; expiry_time);
</pre>
<p>
This function sets the expiry time. Any pending asynchronous wait operations
will be cancelled. The handler for each cancelled operation will be invoked
with the <code class="computeroutput">asio::error::operation_aborted</code> error code.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload2.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_from_now.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.expires_from_now.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">expiry_time</span></dt>
<dd><p>
The expiry time to be used for the timer.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload2.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_from_now.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.expires_from_now.overload2.return_value">Return
Value</a>
</h6>
<p>
The number of asynchronous operations that were cancelled.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload2.h2"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_from_now.overload2.exceptions"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.expires_from_now.overload2.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload2.h3"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_from_now.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.expires_from_now.overload2.remarks">Remarks</a>
</h6>
<p>
If the timer has already expired when <code class="computeroutput">expires_from_now()</code>
is called, then the handlers for asynchronous wait operations will:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
have already been invoked; or
</li>
<li class="listitem">
have been queued for invocation in the near future.
</li>
</ul></div>
<p>
These handlers can no longer be cancelled, and therefore are passed an
error code that indicates the successful completion of the wait operation.
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.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="overload3.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,96 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expires_from_now (3 of 3 overloads)</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="../expires_from_now.html" title="basic_waitable_timer::expires_from_now">
<link rel="prev" href="overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)">
<link rel="next" href="../expiry.html" title="basic_waitable_timer::expiry">
</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="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.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="../expiry.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload3"></a><a class="link" href="overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)">basic_waitable_timer::expires_from_now
(3 of 3 overloads)</a>
</h5></div></div></div>
<p>
(Deprecated: Use <code class="computeroutput">expires_after()</code>.) Set the timer's expiry
time relative to now.
</p>
<pre class="programlisting">std::size_t expires_from_now(
const duration &amp; expiry_time,
asio::error_code &amp; ec);
</pre>
<p>
This function sets the expiry time. Any pending asynchronous wait operations
will be cancelled. The handler for each cancelled operation will be invoked
with the <code class="computeroutput">asio::error::operation_aborted</code> error code.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload3.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_from_now.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.basic_waitable_timer.expires_from_now.overload3.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">expiry_time</span></dt>
<dd><p>
The expiry time to be used for the timer.
</p></dd>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload3.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_from_now.overload3.return_value"></a></span><a class="link" href="overload3.html#asio.reference.basic_waitable_timer.expires_from_now.overload3.return_value">Return
Value</a>
</h6>
<p>
The number of asynchronous operations that were cancelled.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.expires_from_now.overload3.h2"></a>
<span><a name="asio.reference.basic_waitable_timer.expires_from_now.overload3.remarks"></a></span><a class="link" href="overload3.html#asio.reference.basic_waitable_timer.expires_from_now.overload3.remarks">Remarks</a>
</h6>
<p>
If the timer has already expired when <code class="computeroutput">expires_from_now()</code>
is called, then the handlers for asynchronous wait operations will:
</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
have already been invoked; or
</li>
<li class="listitem">
have been queued for invocation in the near future.
</li>
</ul></div>
<p>
These handlers can no longer be cancelled, and therefore are passed an
error code that indicates the successful completion of the wait operation.
</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="overload2.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.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="../expiry.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,48 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::expiry</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="expires_from_now/overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)">
<link rel="next" href="get_executor.html" title="basic_waitable_timer::get_executor">
</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="expires_from_now/overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="get_executor.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_waitable_timer.expiry"></a><a class="link" href="expiry.html" title="basic_waitable_timer::expiry">basic_waitable_timer::expiry</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.expiry"></a>
Get
the timer's expiry time as an absolute time.
</p>
<pre class="programlisting">time_point expiry() const;
</pre>
<p>
This function may be used to obtain the timer's current expiry time. Whether
the timer has expired or not does not affect this value.
</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="expires_from_now/overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="get_executor.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,44 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::get_executor</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="expiry.html" title="basic_waitable_timer::expiry">
<link rel="next" href="operator_eq_.html" title="basic_waitable_timer::operator=">
</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="expiry.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="operator_eq_.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_waitable_timer.get_executor"></a><a class="link" href="get_executor.html" title="basic_waitable_timer::get_executor">basic_waitable_timer::get_executor</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.get_executor"></a>
Get
the executor associated with the object.
</p>
<pre class="programlisting">executor_type get_executor();
</pre>
</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="expiry.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="operator_eq_.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,53 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::operator=</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="get_executor.html" title="basic_waitable_timer::get_executor">
<link rel="next" href="operator_eq_/overload1.html" title="basic_waitable_timer::operator= (1 of 2 overloads)">
</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="get_executor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="operator_eq_/overload1.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_waitable_timer.operator_eq_"></a><a class="link" href="operator_eq_.html" title="basic_waitable_timer::operator=">basic_waitable_timer::operator=</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.operator_eq_"></a>
Move-assign
a <a class="link" href="../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
from another.
</p>
<pre class="programlisting">basic_waitable_timer &amp; <a class="link" href="operator_eq_/overload1.html" title="basic_waitable_timer::operator= (1 of 2 overloads)">operator=</a>(
basic_waitable_timer &amp;&amp; other);
<span class="emphasis"><em>» <a class="link" href="operator_eq_/overload1.html" title="basic_waitable_timer::operator= (1 of 2 overloads)">more...</a></em></span>
template&lt;
typename <a class="link" href="../Executor1.html" title="Executor requirements">Executor1</a>&gt;
enable_if&lt; is_convertible&lt; Executor1, Executor &gt;::value, basic_waitable_timer &amp; &gt;::type <a class="link" href="operator_eq_/overload2.html" title="basic_waitable_timer::operator= (2 of 2 overloads)">operator=</a>(
basic_waitable_timer&lt; Clock, WaitTraits, Executor1 &gt; &amp;&amp; other);
<span class="emphasis"><em>» <a class="link" href="operator_eq_/overload2.html" title="basic_waitable_timer::operator= (2 of 2 overloads)">more...</a></em></span>
</pre>
</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="get_executor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="operator_eq_/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,72 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::operator= (1 of 2 overloads)</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="../operator_eq_.html" title="basic_waitable_timer::operator=">
<link rel="prev" href="../operator_eq_.html" title="basic_waitable_timer::operator=">
<link rel="next" href="overload2.html" title="basic_waitable_timer::operator= (2 of 2 overloads)">
</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="../operator_eq_.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../operator_eq_.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.operator_eq_.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::operator= (1 of 2 overloads)">basic_waitable_timer::operator=
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Move-assign a <a class="link" href="../../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
from another.
</p>
<pre class="programlisting">basic_waitable_timer &amp; operator=(
basic_waitable_timer &amp;&amp; other);
</pre>
<p>
This assignment operator moves a timer from one object to another. Cancels
any outstanding asynchronous operations associated with the target object.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.operator_eq_.overload1.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.operator_eq_.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.operator_eq_.overload1.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">other</span></dt>
<dd><p>
The other <a class="link" href="../../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
object from which the move will occur.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.operator_eq_.overload1.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.operator_eq_.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.operator_eq_.overload1.remarks">Remarks</a>
</h6>
<p>
Following the move, the moved-from object is in the same state as if
constructed using the <code class="computeroutput">basic_waitable_timer(const executor_type&amp;)</code>
constructor.
</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="../operator_eq_.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../operator_eq_.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,74 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::operator= (2 of 2 overloads)</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="../operator_eq_.html" title="basic_waitable_timer::operator=">
<link rel="prev" href="overload1.html" title="basic_waitable_timer::operator= (1 of 2 overloads)">
<link rel="next" href="../time_point.html" title="basic_waitable_timer::time_point">
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../operator_eq_.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="../time_point.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.operator_eq_.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::operator= (2 of 2 overloads)">basic_waitable_timer::operator=
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Move-assign a <a class="link" href="../../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
from another.
</p>
<pre class="programlisting">template&lt;
typename <a class="link" href="../../Executor1.html" title="Executor requirements">Executor1</a>&gt;
enable_if&lt; is_convertible&lt; Executor1, Executor &gt;::value, basic_waitable_timer &amp; &gt;::type operator=(
basic_waitable_timer&lt; Clock, WaitTraits, Executor1 &gt; &amp;&amp; other);
</pre>
<p>
This assignment operator moves a timer from one object to another. Cancels
any outstanding asynchronous operations associated with the target object.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.operator_eq_.overload2.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.operator_eq_.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.operator_eq_.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">other</span></dt>
<dd><p>
The other <a class="link" href="../../basic_waitable_timer.html" title="basic_waitable_timer"><code class="computeroutput">basic_waitable_timer</code></a>
object from which the move will occur.
</p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.basic_waitable_timer.operator_eq_.overload2.h1"></a>
<span><a name="asio.reference.basic_waitable_timer.operator_eq_.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.operator_eq_.overload2.remarks">Remarks</a>
</h6>
<p>
Following the move, the moved-from object is in the same state as if
constructed using the <code class="computeroutput">basic_waitable_timer(const executor_type&amp;)</code>
constructor.
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../operator_eq_.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="../time_point.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::time_point</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="operator_eq_/overload2.html" title="basic_waitable_timer::operator= (2 of 2 overloads)">
<link rel="next" href="traits_type.html" title="basic_waitable_timer::traits_type">
</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="operator_eq_/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="traits_type.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_waitable_timer.time_point"></a><a class="link" href="time_point.html" title="basic_waitable_timer::time_point">basic_waitable_timer::time_point</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.time_point"></a>
The
time point type of the clock.
</p>
<pre class="programlisting">typedef clock_type::time_point time_point;
</pre>
<h6>
<a name="asio.reference.basic_waitable_timer.time_point.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.time_point.requirements"></a></span><a class="link" href="time_point.html#asio.reference.basic_waitable_timer.time_point.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_waitable_timer.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="operator_eq_/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="traits_type.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,54 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::traits_type</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="time_point.html" title="basic_waitable_timer::time_point">
<link rel="next" href="wait.html" title="basic_waitable_timer::wait">
</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="time_point.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="wait.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_waitable_timer.traits_type"></a><a class="link" href="traits_type.html" title="basic_waitable_timer::traits_type">basic_waitable_timer::traits_type</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.traits_type"></a>
The
wait traits type.
</p>
<pre class="programlisting">typedef WaitTraits traits_type;
</pre>
<h6>
<a name="asio.reference.basic_waitable_timer.traits_type.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.traits_type.requirements"></a></span><a class="link" href="traits_type.html#asio.reference.basic_waitable_timer.traits_type.requirements">Requirements</a>
</h6>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_waitable_timer.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="time_point.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="wait.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,49 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::wait</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_waitable_timer.html" title="basic_waitable_timer">
<link rel="prev" href="traits_type.html" title="basic_waitable_timer::traits_type">
<link rel="next" href="wait/overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)">
</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="traits_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="wait/overload1.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_waitable_timer.wait"></a><a class="link" href="wait.html" title="basic_waitable_timer::wait">basic_waitable_timer::wait</a>
</h4></div></div></div>
<p>
<a class="indexterm" name="asio.indexterm.basic_waitable_timer.wait"></a>
Perform
a blocking wait on the timer.
</p>
<pre class="programlisting">void <a class="link" href="wait/overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)">wait</a>();
<span class="emphasis"><em>» <a class="link" href="wait/overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)">more...</a></em></span>
void <a class="link" href="wait/overload2.html" title="basic_waitable_timer::wait (2 of 2 overloads)">wait</a>(
asio::error_code &amp; ec);
<span class="emphasis"><em>» <a class="link" href="wait/overload2.html" title="basic_waitable_timer::wait (2 of 2 overloads)">more...</a></em></span>
</pre>
</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="traits_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.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="wait/overload1.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,60 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::wait (1 of 2 overloads)</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="../wait.html" title="basic_waitable_timer::wait">
<link rel="prev" href="../wait.html" title="basic_waitable_timer::wait">
<link rel="next" href="overload2.html" title="basic_waitable_timer::wait (2 of 2 overloads)">
</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="../wait.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../wait.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.wait.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)">basic_waitable_timer::wait
(1 of 2 overloads)</a>
</h5></div></div></div>
<p>
Perform a blocking wait on the timer.
</p>
<pre class="programlisting">void wait();
</pre>
<p>
This function is used to wait for the timer to expire. This function
blocks and does not return until the timer has expired.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.wait.overload1.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.wait.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.basic_waitable_timer.wait.overload1.exceptions">Exceptions</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
Thrown on failure.
</p></dd>
</dl>
</div>
</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="../wait.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../wait.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="overload2.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>
@@ -0,0 +1,61 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>basic_waitable_timer::wait (2 of 2 overloads)</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="../wait.html" title="basic_waitable_timer::wait">
<link rel="prev" href="overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)">
<link rel="next" href="../_basic_waitable_timer.html" title="basic_waitable_timer::~basic_waitable_timer">
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../wait.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="../_basic_waitable_timer.html"><img src="../../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h5 class="title">
<a name="asio.reference.basic_waitable_timer.wait.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::wait (2 of 2 overloads)">basic_waitable_timer::wait
(2 of 2 overloads)</a>
</h5></div></div></div>
<p>
Perform a blocking wait on the timer.
</p>
<pre class="programlisting">void wait(
asio::error_code &amp; ec);
</pre>
<p>
This function is used to wait for the timer to expire. This function
blocks and does not return until the timer has expired.
</p>
<h6>
<a name="asio.reference.basic_waitable_timer.wait.overload2.h0"></a>
<span><a name="asio.reference.basic_waitable_timer.wait.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_waitable_timer.wait.overload2.parameters">Parameters</a>
</h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">ec</span></dt>
<dd><p>
Set to indicate what error occurred, if any.
</p></dd>
</dl>
</div>
</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="overload1.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../wait.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="../_basic_waitable_timer.html"><img src="../../../../next.png" alt="Next"></a>
</div>
</body>
</html>