Adds asio library and Storage Module
This commit is contained in:
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_deadline_timer::~basic_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="wait/overload2.html" title="basic_deadline_timer::wait (2 of 2 overloads)">
|
||||
<link rel="next" href="../basic_deadline_timer__rebind_executor.html" title="basic_deadline_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_deadline_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_deadline_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_deadline_timer._basic_deadline_timer"></a><a class="link" href="_basic_deadline_timer.html" title="basic_deadline_timer::~basic_deadline_timer">basic_deadline_timer::~basic_deadline_timer</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer._basic_deadline_timer"></a>
|
||||
Destroys
|
||||
the timer.
|
||||
</p>
|
||||
<pre class="programlisting">~basic_deadline_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_deadline_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_deadline_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_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="../basic_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="next" href="basic_deadline_timer.html" title="basic_deadline_timer::basic_deadline_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_deadline_timer.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_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_deadline_timer.async_wait"></a><a class="link" href="async_wait.html" title="basic_deadline_timer::async_wait">basic_deadline_timer::async_wait</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer.async_wait"></a>
|
||||
Start
|
||||
an asynchronous wait on the timer.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
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>>
|
||||
<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 && 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_deadline_timer.async_wait.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.async_wait.parameters"></a></span><a class="link" href="async_wait.html#asio.reference.basic_deadline_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& 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_deadline_timer.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
@@ -0,0 +1,92 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_timer::basic_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="async_wait.html" title="basic_deadline_timer::async_wait">
|
||||
<link rel="next" href="basic_deadline_timer/overload1.html" title="basic_deadline_timer::basic_deadline_timer (1 of 7 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_deadline_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_deadline_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_deadline_timer.basic_deadline_timer"></a><a class="link" href="basic_deadline_timer.html" title="basic_deadline_timer::basic_deadline_timer">basic_deadline_timer::basic_deadline_timer</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer.basic_deadline_timer"></a>
|
||||
Constructor.
|
||||
</p>
|
||||
<pre class="programlisting">explicit <a class="link" href="basic_deadline_timer/overload1.html" title="basic_deadline_timer::basic_deadline_timer (1 of 7 overloads)">basic_deadline_timer</a>(
|
||||
const executor_type & ex);
|
||||
<span class="emphasis"><em>» <a class="link" href="basic_deadline_timer/overload1.html" title="basic_deadline_timer::basic_deadline_timer (1 of 7 overloads)">more...</a></em></span>
|
||||
|
||||
template<
|
||||
typename ExecutionContext>
|
||||
explicit <a class="link" href="basic_deadline_timer/overload2.html" title="basic_deadline_timer::basic_deadline_timer (2 of 7 overloads)">basic_deadline_timer</a>(
|
||||
ExecutionContext & context,
|
||||
typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0);
|
||||
<span class="emphasis"><em>» <a class="link" href="basic_deadline_timer/overload2.html" title="basic_deadline_timer::basic_deadline_timer (2 of 7 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_deadline_timer/overload3.html" title="basic_deadline_timer::basic_deadline_timer (3 of 7 overloads)">basic_deadline_timer</a>(
|
||||
const executor_type & ex,
|
||||
const time_type & expiry_time);
|
||||
<span class="emphasis"><em>» <a class="link" href="basic_deadline_timer/overload3.html" title="basic_deadline_timer::basic_deadline_timer (3 of 7 overloads)">more...</a></em></span>
|
||||
|
||||
template<
|
||||
typename ExecutionContext>
|
||||
<a class="link" href="basic_deadline_timer/overload4.html" title="basic_deadline_timer::basic_deadline_timer (4 of 7 overloads)">basic_deadline_timer</a>(
|
||||
ExecutionContext & context,
|
||||
const time_type & expiry_time,
|
||||
typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0);
|
||||
<span class="emphasis"><em>» <a class="link" href="basic_deadline_timer/overload4.html" title="basic_deadline_timer::basic_deadline_timer (4 of 7 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_deadline_timer/overload5.html" title="basic_deadline_timer::basic_deadline_timer (5 of 7 overloads)">basic_deadline_timer</a>(
|
||||
const executor_type & ex,
|
||||
const duration_type & expiry_time);
|
||||
<span class="emphasis"><em>» <a class="link" href="basic_deadline_timer/overload5.html" title="basic_deadline_timer::basic_deadline_timer (5 of 7 overloads)">more...</a></em></span>
|
||||
|
||||
template<
|
||||
typename ExecutionContext>
|
||||
<a class="link" href="basic_deadline_timer/overload6.html" title="basic_deadline_timer::basic_deadline_timer (6 of 7 overloads)">basic_deadline_timer</a>(
|
||||
ExecutionContext & context,
|
||||
const duration_type & expiry_time,
|
||||
typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0);
|
||||
<span class="emphasis"><em>» <a class="link" href="basic_deadline_timer/overload6.html" title="basic_deadline_timer::basic_deadline_timer (6 of 7 overloads)">more...</a></em></span>
|
||||
</pre>
|
||||
<p>
|
||||
Move-construct a <a class="link" href="../basic_deadline_timer.html" title="basic_deadline_timer"><code class="computeroutput">basic_deadline_timer</code></a>
|
||||
from another.
|
||||
</p>
|
||||
<pre class="programlisting"><a class="link" href="basic_deadline_timer/overload7.html" title="basic_deadline_timer::basic_deadline_timer (7 of 7 overloads)">basic_deadline_timer</a>(
|
||||
basic_deadline_timer && other);
|
||||
<span class="emphasis"><em>» <a class="link" href="basic_deadline_timer/overload7.html" title="basic_deadline_timer::basic_deadline_timer (7 of 7 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_deadline_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_deadline_timer/overload1.html"><img src="../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
+63
@@ -0,0 +1,63 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_timer::basic_deadline_timer (1 of 7 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_deadline_timer.html" title="basic_deadline_timer::basic_deadline_timer">
|
||||
<link rel="prev" href="../basic_deadline_timer.html" title="basic_deadline_timer::basic_deadline_timer">
|
||||
<link rel="next" href="overload2.html" title="basic_deadline_timer::basic_deadline_timer (2 of 7 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_deadline_timer.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.basic_deadline_timer.overload1"></a><a class="link" href="overload1.html" title="basic_deadline_timer::basic_deadline_timer (1 of 7 overloads)">basic_deadline_timer::basic_deadline_timer
|
||||
(1 of 7 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Constructor.
|
||||
</p>
|
||||
<pre class="programlisting">basic_deadline_timer(
|
||||
const executor_type & 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_from_now()</code> functions
|
||||
must be called to set an expiry time before the timer can be waited on.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload1.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload1.parameters"></a></span><a class="link" href="overload1.html#asio.reference.basic_deadline_timer.basic_deadline_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_deadline_timer.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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>
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_timer::basic_deadline_timer (2 of 7 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_deadline_timer.html" title="basic_deadline_timer::basic_deadline_timer">
|
||||
<link rel="prev" href="overload1.html" title="basic_deadline_timer::basic_deadline_timer (1 of 7 overloads)">
|
||||
<link rel="next" href="overload3.html" title="basic_deadline_timer::basic_deadline_timer (3 of 7 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_deadline_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_deadline_timer.basic_deadline_timer.overload2"></a><a class="link" href="overload2.html" title="basic_deadline_timer::basic_deadline_timer (2 of 7 overloads)">basic_deadline_timer::basic_deadline_timer
|
||||
(2 of 7 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Constructor.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename ExecutionContext>
|
||||
basic_deadline_timer(
|
||||
ExecutionContext & context,
|
||||
typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::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_from_now()</code> functions
|
||||
must be called to set an expiry time before the timer can be waited on.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload2.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_timer.basic_deadline_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_deadline_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>
|
||||
+67
@@ -0,0 +1,67 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_timer::basic_deadline_timer (3 of 7 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_deadline_timer.html" title="basic_deadline_timer::basic_deadline_timer">
|
||||
<link rel="prev" href="overload2.html" title="basic_deadline_timer::basic_deadline_timer (2 of 7 overloads)">
|
||||
<link rel="next" href="overload4.html" title="basic_deadline_timer::basic_deadline_timer (4 of 7 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_deadline_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_deadline_timer.basic_deadline_timer.overload3"></a><a class="link" href="overload3.html" title="basic_deadline_timer::basic_deadline_timer (3 of 7 overloads)">basic_deadline_timer::basic_deadline_timer
|
||||
(3 of 7 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Constructor to set a particular expiry time as an absolute time.
|
||||
</p>
|
||||
<pre class="programlisting">basic_deadline_timer(
|
||||
const executor_type & ex,
|
||||
const time_type & expiry_time);
|
||||
</pre>
|
||||
<p>
|
||||
This constructor creates a timer and sets the expiry time.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload3.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.basic_deadline_timer.basic_deadline_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 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_deadline_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>
|
||||
+71
@@ -0,0 +1,71 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_timer::basic_deadline_timer (4 of 7 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_deadline_timer.html" title="basic_deadline_timer::basic_deadline_timer">
|
||||
<link rel="prev" href="overload3.html" title="basic_deadline_timer::basic_deadline_timer (3 of 7 overloads)">
|
||||
<link rel="next" href="overload5.html" title="basic_deadline_timer::basic_deadline_timer (5 of 7 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_deadline_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_deadline_timer.basic_deadline_timer.overload4"></a><a class="link" href="overload4.html" title="basic_deadline_timer::basic_deadline_timer (4 of 7 overloads)">basic_deadline_timer::basic_deadline_timer
|
||||
(4 of 7 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Constructor to set a particular expiry time as an absolute time.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename ExecutionContext>
|
||||
basic_deadline_timer(
|
||||
ExecutionContext & context,
|
||||
const time_type & expiry_time,
|
||||
typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This constructor creates a timer and sets the expiry time.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload4.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload4.parameters"></a></span><a class="link" href="overload4.html#asio.reference.basic_deadline_timer.basic_deadline_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_deadline_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>
|
||||
+66
@@ -0,0 +1,66 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_timer::basic_deadline_timer (5 of 7 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_deadline_timer.html" title="basic_deadline_timer::basic_deadline_timer">
|
||||
<link rel="prev" href="overload4.html" title="basic_deadline_timer::basic_deadline_timer (4 of 7 overloads)">
|
||||
<link rel="next" href="overload6.html" title="basic_deadline_timer::basic_deadline_timer (6 of 7 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_deadline_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_deadline_timer.basic_deadline_timer.overload5"></a><a class="link" href="overload5.html" title="basic_deadline_timer::basic_deadline_timer (5 of 7 overloads)">basic_deadline_timer::basic_deadline_timer
|
||||
(5 of 7 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Constructor to set a particular expiry time relative to now.
|
||||
</p>
|
||||
<pre class="programlisting">basic_deadline_timer(
|
||||
const executor_type & ex,
|
||||
const duration_type & expiry_time);
|
||||
</pre>
|
||||
<p>
|
||||
This constructor creates a timer and sets the expiry time.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload5.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload5.parameters"></a></span><a class="link" href="overload5.html#asio.reference.basic_deadline_timer.basic_deadline_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_deadline_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>
|
||||
+70
@@ -0,0 +1,70 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_timer::basic_deadline_timer (6 of 7 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_deadline_timer.html" title="basic_deadline_timer::basic_deadline_timer">
|
||||
<link rel="prev" href="overload5.html" title="basic_deadline_timer::basic_deadline_timer (5 of 7 overloads)">
|
||||
<link rel="next" href="overload7.html" title="basic_deadline_timer::basic_deadline_timer (7 of 7 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_deadline_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_deadline_timer.basic_deadline_timer.overload6"></a><a class="link" href="overload6.html" title="basic_deadline_timer::basic_deadline_timer (6 of 7 overloads)">basic_deadline_timer::basic_deadline_timer
|
||||
(6 of 7 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Constructor to set a particular expiry time relative to now.
|
||||
</p>
|
||||
<pre class="programlisting">template<
|
||||
typename ExecutionContext>
|
||||
basic_deadline_timer(
|
||||
ExecutionContext & context,
|
||||
const duration_type & expiry_time,
|
||||
typename enable_if< is_convertible< ExecutionContext &, execution_context & >::value >::type * = 0);
|
||||
</pre>
|
||||
<p>
|
||||
This constructor creates a timer and sets the expiry time.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload6.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload6.parameters"></a></span><a class="link" href="overload6.html#asio.reference.basic_deadline_timer.basic_deadline_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_deadline_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>
|
||||
+71
@@ -0,0 +1,71 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_timer::basic_deadline_timer (7 of 7 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_deadline_timer.html" title="basic_deadline_timer::basic_deadline_timer">
|
||||
<link rel="prev" href="overload6.html" title="basic_deadline_timer::basic_deadline_timer (6 of 7 overloads)">
|
||||
<link rel="next" href="../cancel.html" title="basic_deadline_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="overload6.html"><img src="../../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.basic_deadline_timer.overload7"></a><a class="link" href="overload7.html" title="basic_deadline_timer::basic_deadline_timer (7 of 7 overloads)">basic_deadline_timer::basic_deadline_timer
|
||||
(7 of 7 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Move-construct a <a class="link" href="../../basic_deadline_timer.html" title="basic_deadline_timer"><code class="computeroutput">basic_deadline_timer</code></a>
|
||||
from another.
|
||||
</p>
|
||||
<pre class="programlisting">basic_deadline_timer(
|
||||
basic_deadline_timer && other);
|
||||
</pre>
|
||||
<p>
|
||||
This constructor moves a timer from one object to another.
|
||||
</p>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload7.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload7.parameters"></a></span><a class="link" href="overload7.html#asio.reference.basic_deadline_timer.basic_deadline_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_deadline_timer.html" title="basic_deadline_timer"><code class="computeroutput">basic_deadline_timer</code></a>
|
||||
object from which the move will occur.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload7.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.basic_deadline_timer.overload7.remarks"></a></span><a class="link" href="overload7.html#asio.reference.basic_deadline_timer.basic_deadline_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_deadline_timer(const executor_type&)</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_deadline_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,49 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="basic_deadline_timer/overload7.html" title="basic_deadline_timer::basic_deadline_timer (7 of 7 overloads)">
|
||||
<link rel="next" href="cancel/overload1.html" title="basic_deadline_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_deadline_timer/overload7.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.cancel"></a><a class="link" href="cancel.html" title="basic_deadline_timer::cancel">basic_deadline_timer::cancel</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_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_deadline_timer::cancel (1 of 2 overloads)">cancel</a>();
|
||||
<span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="basic_deadline_timer::cancel (1 of 2 overloads)">more...</a></em></span>
|
||||
|
||||
std::size_t <a class="link" href="cancel/overload2.html" title="basic_deadline_timer::cancel (2 of 2 overloads)">cancel</a>(
|
||||
asio::error_code & ec);
|
||||
<span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="basic_deadline_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_deadline_timer/overload7.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_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_deadline_timer::cancel">
|
||||
<link rel="prev" href="../cancel.html" title="basic_deadline_timer::cancel">
|
||||
<link rel="next" href="overload2.html" title="basic_deadline_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_deadline_timer.cancel.overload1"></a><a class="link" href="overload1.html" title="basic_deadline_timer::cancel (1 of 2 overloads)">basic_deadline_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_deadline_timer.cancel.overload1.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.basic_deadline_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_deadline_timer.cancel.overload1.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.basic_deadline_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_deadline_timer.cancel.overload1.h2"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.basic_deadline_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,94 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer::cancel">
|
||||
<link rel="prev" href="overload1.html" title="basic_deadline_timer::cancel (1 of 2 overloads)">
|
||||
<link rel="next" href="../cancel_one.html" title="basic_deadline_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_deadline_timer.cancel.overload2"></a><a class="link" href="overload2.html" title="basic_deadline_timer::cancel (2 of 2 overloads)">basic_deadline_timer::cancel
|
||||
(2 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(
|
||||
asio::error_code & 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_deadline_timer.cancel.overload2.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.cancel.overload2.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.cancel.overload2.h2"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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,49 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="cancel/overload2.html" title="basic_deadline_timer::cancel (2 of 2 overloads)">
|
||||
<link rel="next" href="cancel_one/overload1.html" title="basic_deadline_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_deadline_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_deadline_timer.cancel_one"></a><a class="link" href="cancel_one.html" title="basic_deadline_timer::cancel_one">basic_deadline_timer::cancel_one</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_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_deadline_timer::cancel_one (1 of 2 overloads)">cancel_one</a>();
|
||||
<span class="emphasis"><em>» <a class="link" href="cancel_one/overload1.html" title="basic_deadline_timer::cancel_one (1 of 2 overloads)">more...</a></em></span>
|
||||
|
||||
std::size_t <a class="link" href="cancel_one/overload2.html" title="basic_deadline_timer::cancel_one (2 of 2 overloads)">cancel_one</a>(
|
||||
asio::error_code & ec);
|
||||
<span class="emphasis"><em>» <a class="link" href="cancel_one/overload2.html" title="basic_deadline_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_deadline_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_deadline_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_deadline_timer::cancel_one">
|
||||
<link rel="prev" href="../cancel_one.html" title="basic_deadline_timer::cancel_one">
|
||||
<link rel="next" href="overload2.html" title="basic_deadline_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_deadline_timer.cancel_one.overload1"></a><a class="link" href="overload1.html" title="basic_deadline_timer::cancel_one (1 of 2 overloads)">basic_deadline_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_deadline_timer.cancel_one.overload1.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel_one.overload1.return_value"></a></span><a class="link" href="overload1.html#asio.reference.basic_deadline_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_deadline_timer.cancel_one.overload1.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel_one.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.basic_deadline_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_deadline_timer.cancel_one.overload1.h2"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel_one.overload1.remarks"></a></span><a class="link" href="overload1.html#asio.reference.basic_deadline_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,95 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer::cancel_one">
|
||||
<link rel="prev" href="overload1.html" title="basic_deadline_timer::cancel_one (1 of 2 overloads)">
|
||||
<link rel="next" href="../duration_type.html" title="basic_deadline_timer::duration_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="../duration_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_deadline_timer.cancel_one.overload2"></a><a class="link" href="overload2.html" title="basic_deadline_timer::cancel_one (2 of 2 overloads)">basic_deadline_timer::cancel_one
|
||||
(2 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(
|
||||
asio::error_code & 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_deadline_timer.cancel_one.overload2.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel_one.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.cancel_one.overload2.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel_one.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.cancel_one.overload2.h2"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.cancel_one.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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="../duration_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_deadline_timer::duration_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="cancel_one/overload2.html" title="basic_deadline_timer::cancel_one (2 of 2 overloads)">
|
||||
<link rel="next" href="executor_type.html" title="basic_deadline_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="cancel_one/overload2.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.duration_type"></a><a class="link" href="duration_type.html" title="basic_deadline_timer::duration_type">basic_deadline_timer::duration_type</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer.duration_type"></a>
|
||||
The
|
||||
duration type.
|
||||
</p>
|
||||
<pre class="programlisting">typedef traits_type::duration_type duration_type;
|
||||
</pre>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.duration_type.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.duration_type.requirements"></a></span><a class="link" href="duration_type.html#asio.reference.basic_deadline_timer.duration_type.requirements">Requirements</a>
|
||||
</h6>
|
||||
<p>
|
||||
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_deadline_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_deadline_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_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="duration_type.html" title="basic_deadline_timer::duration_type">
|
||||
<link rel="next" href="expires_at.html" title="basic_deadline_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="duration_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.executor_type"></a><a class="link" href="executor_type.html" title="basic_deadline_timer::executor_type">basic_deadline_timer::executor_type</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_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_deadline_timer.executor_type.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.executor_type.requirements"></a></span><a class="link" href="executor_type.html#asio.reference.basic_deadline_timer.executor_type.requirements">Requirements</a>
|
||||
</h6>
|
||||
<p>
|
||||
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_deadline_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_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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,57 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="executor_type.html" title="basic_deadline_timer::executor_type">
|
||||
<link rel="next" href="expires_at/overload1.html" title="basic_deadline_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="executor_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.expires_at"></a><a class="link" href="expires_at.html" title="basic_deadline_timer::expires_at">basic_deadline_timer::expires_at</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer.expires_at"></a>
|
||||
Get
|
||||
the timer's expiry time as an absolute time.
|
||||
</p>
|
||||
<pre class="programlisting">time_type <a class="link" href="expires_at/overload1.html" title="basic_deadline_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_deadline_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_deadline_timer::expires_at (2 of 3 overloads)">expires_at</a>(
|
||||
const time_type & expiry_time);
|
||||
<span class="emphasis"><em>» <a class="link" href="expires_at/overload2.html" title="basic_deadline_timer::expires_at (2 of 3 overloads)">more...</a></em></span>
|
||||
|
||||
std::size_t <a class="link" href="expires_at/overload3.html" title="basic_deadline_timer::expires_at (3 of 3 overloads)">expires_at</a>(
|
||||
const time_type & expiry_time,
|
||||
asio::error_code & ec);
|
||||
<span class="emphasis"><em>» <a class="link" href="expires_at/overload3.html" title="basic_deadline_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="executor_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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,47 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer::expires_at">
|
||||
<link rel="prev" href="../expires_at.html" title="basic_deadline_timer::expires_at">
|
||||
<link rel="next" href="overload2.html" title="basic_deadline_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_deadline_timer.expires_at.overload1"></a><a class="link" href="overload1.html" title="basic_deadline_timer::expires_at (1 of 3 overloads)">basic_deadline_timer::expires_at
|
||||
(1 of 3 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Get the timer's expiry time as an absolute time.
|
||||
</p>
|
||||
<pre class="programlisting">time_type 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_deadline_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_deadline_timer::expires_at">
|
||||
<link rel="prev" href="overload1.html" title="basic_deadline_timer::expires_at (1 of 3 overloads)">
|
||||
<link rel="next" href="overload3.html" title="basic_deadline_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_deadline_timer.expires_at.overload2"></a><a class="link" href="overload2.html" title="basic_deadline_timer::expires_at (2 of 3 overloads)">basic_deadline_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_type & 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_deadline_timer.expires_at.overload2.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_at.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.expires_at.overload2.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_at.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.expires_at.overload2.h2"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_at.overload2.exceptions"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.expires_at.overload2.h3"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_at.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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,95 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer::expires_at">
|
||||
<link rel="prev" href="overload2.html" title="basic_deadline_timer::expires_at (2 of 3 overloads)">
|
||||
<link rel="next" href="../expires_from_now.html" title="basic_deadline_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_deadline_timer.expires_at.overload3"></a><a class="link" href="overload3.html" title="basic_deadline_timer::expires_at (3 of 3 overloads)">basic_deadline_timer::expires_at
|
||||
(3 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_type & expiry_time,
|
||||
asio::error_code & 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_deadline_timer.expires_at.overload3.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_at.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.basic_deadline_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_deadline_timer.expires_at.overload3.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_at.overload3.return_value"></a></span><a class="link" href="overload3.html#asio.reference.basic_deadline_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_deadline_timer.expires_at.overload3.h2"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_at.overload3.remarks"></a></span><a class="link" href="overload3.html#asio.reference.basic_deadline_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,57 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="expires_at/overload3.html" title="basic_deadline_timer::expires_at (3 of 3 overloads)">
|
||||
<link rel="next" href="expires_from_now/overload1.html" title="basic_deadline_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_deadline_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_deadline_timer.expires_from_now"></a><a class="link" href="expires_from_now.html" title="basic_deadline_timer::expires_from_now">basic_deadline_timer::expires_from_now</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer.expires_from_now"></a>
|
||||
Get
|
||||
the timer's expiry time relative to now.
|
||||
</p>
|
||||
<pre class="programlisting">duration_type <a class="link" href="expires_from_now/overload1.html" title="basic_deadline_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_deadline_timer::expires_from_now (1 of 3 overloads)">more...</a></em></span>
|
||||
</pre>
|
||||
<p>
|
||||
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_deadline_timer::expires_from_now (2 of 3 overloads)">expires_from_now</a>(
|
||||
const duration_type & expiry_time);
|
||||
<span class="emphasis"><em>» <a class="link" href="expires_from_now/overload2.html" title="basic_deadline_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_deadline_timer::expires_from_now (3 of 3 overloads)">expires_from_now</a>(
|
||||
const duration_type & expiry_time,
|
||||
asio::error_code & ec);
|
||||
<span class="emphasis"><em>» <a class="link" href="expires_from_now/overload3.html" title="basic_deadline_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_deadline_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>
|
||||
+47
@@ -0,0 +1,47 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer::expires_from_now">
|
||||
<link rel="prev" href="../expires_from_now.html" title="basic_deadline_timer::expires_from_now">
|
||||
<link rel="next" href="overload2.html" title="basic_deadline_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_deadline_timer.expires_from_now.overload1"></a><a class="link" href="overload1.html" title="basic_deadline_timer::expires_from_now (1 of 3 overloads)">basic_deadline_timer::expires_from_now
|
||||
(1 of 3 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Get the timer's expiry time relative to now.
|
||||
</p>
|
||||
<pre class="programlisting">duration_type 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>
|
||||
+103
@@ -0,0 +1,103 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer::expires_from_now">
|
||||
<link rel="prev" href="overload1.html" title="basic_deadline_timer::expires_from_now (1 of 3 overloads)">
|
||||
<link rel="next" href="overload3.html" title="basic_deadline_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_deadline_timer.expires_from_now.overload2"></a><a class="link" href="overload2.html" title="basic_deadline_timer::expires_from_now (2 of 3 overloads)">basic_deadline_timer::expires_from_now
|
||||
(2 of 3 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Set the timer's expiry time relative to now.
|
||||
</p>
|
||||
<pre class="programlisting">std::size_t expires_from_now(
|
||||
const duration_type & 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_deadline_timer.expires_from_now.overload2.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_from_now.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.expires_from_now.overload2.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_from_now.overload2.return_value"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.expires_from_now.overload2.h2"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_from_now.overload2.exceptions"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.expires_from_now.overload2.h3"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_from_now.overload2.remarks"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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>
|
||||
+95
@@ -0,0 +1,95 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer::expires_from_now">
|
||||
<link rel="prev" href="overload2.html" title="basic_deadline_timer::expires_from_now (2 of 3 overloads)">
|
||||
<link rel="next" href="../get_executor.html" title="basic_deadline_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="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="../get_executor.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_deadline_timer.expires_from_now.overload3"></a><a class="link" href="overload3.html" title="basic_deadline_timer::expires_from_now (3 of 3 overloads)">basic_deadline_timer::expires_from_now
|
||||
(3 of 3 overloads)</a>
|
||||
</h5></div></div></div>
|
||||
<p>
|
||||
Set the timer's expiry time relative to now.
|
||||
</p>
|
||||
<pre class="programlisting">std::size_t expires_from_now(
|
||||
const duration_type & expiry_time,
|
||||
asio::error_code & 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_deadline_timer.expires_from_now.overload3.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_from_now.overload3.parameters"></a></span><a class="link" href="overload3.html#asio.reference.basic_deadline_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_deadline_timer.expires_from_now.overload3.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_from_now.overload3.return_value"></a></span><a class="link" href="overload3.html#asio.reference.basic_deadline_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_deadline_timer.expires_from_now.overload3.h2"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.expires_from_now.overload3.remarks"></a></span><a class="link" href="overload3.html#asio.reference.basic_deadline_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="../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_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="expires_from_now/overload3.html" title="basic_deadline_timer::expires_from_now (3 of 3 overloads)">
|
||||
<link rel="next" href="operator_eq_.html" title="basic_deadline_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="expires_from_now/overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.get_executor"></a><a class="link" href="get_executor.html" title="basic_deadline_timer::get_executor">basic_deadline_timer::get_executor</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_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="expires_from_now/overload3.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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,72 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||||
<title>basic_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="get_executor.html" title="basic_deadline_timer::get_executor">
|
||||
<link rel="next" href="time_type.html" title="basic_deadline_timer::time_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="get_executor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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="time_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_deadline_timer.operator_eq_"></a><a class="link" href="operator_eq_.html" title="basic_deadline_timer::operator=">basic_deadline_timer::operator=</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer.operator_eq_"></a>
|
||||
Move-assign
|
||||
a <a class="link" href="../basic_deadline_timer.html" title="basic_deadline_timer"><code class="computeroutput">basic_deadline_timer</code></a>
|
||||
from another.
|
||||
</p>
|
||||
<pre class="programlisting">basic_deadline_timer & operator=(
|
||||
basic_deadline_timer && 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_deadline_timer.operator_eq_.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.operator_eq_.parameters"></a></span><a class="link" href="operator_eq_.html#asio.reference.basic_deadline_timer.operator_eq_.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_deadline_timer.html" title="basic_deadline_timer"><code class="computeroutput">basic_deadline_timer</code></a>
|
||||
object from which the move will occur.
|
||||
</p></dd>
|
||||
</dl>
|
||||
</div>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.operator_eq_.h1"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.operator_eq_.remarks"></a></span><a class="link" href="operator_eq_.html#asio.reference.basic_deadline_timer.operator_eq_.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_deadline_timer(const executor_type&)</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="get_executor.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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="time_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_deadline_timer::time_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="operator_eq_.html" title="basic_deadline_timer::operator=">
|
||||
<link rel="next" href="traits_type.html" title="basic_deadline_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_.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.time_type"></a><a class="link" href="time_type.html" title="basic_deadline_timer::time_type">basic_deadline_timer::time_type</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer.time_type"></a>
|
||||
The
|
||||
time type.
|
||||
</p>
|
||||
<pre class="programlisting">typedef traits_type::time_type time_type;
|
||||
</pre>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.time_type.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.time_type.requirements"></a></span><a class="link" href="time_type.html#asio.reference.basic_deadline_timer.time_type.requirements">Requirements</a>
|
||||
</h6>
|
||||
<p>
|
||||
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_deadline_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_.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="time_type.html" title="basic_deadline_timer::time_type">
|
||||
<link rel="next" href="wait.html" title="basic_deadline_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_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_timer.traits_type"></a><a class="link" href="traits_type.html" title="basic_deadline_timer::traits_type">basic_deadline_timer::traits_type</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer.traits_type"></a>
|
||||
The
|
||||
time traits type.
|
||||
</p>
|
||||
<pre class="programlisting">typedef TimeTraits traits_type;
|
||||
</pre>
|
||||
<h6>
|
||||
<a name="asio.reference.basic_deadline_timer.traits_type.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.traits_type.requirements"></a></span><a class="link" href="traits_type.html#asio.reference.basic_deadline_timer.traits_type.requirements">Requirements</a>
|
||||
</h6>
|
||||
<p>
|
||||
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/basic_deadline_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_type.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../basic_deadline_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_deadline_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_deadline_timer.html" title="basic_deadline_timer">
|
||||
<link rel="prev" href="traits_type.html" title="basic_deadline_timer::traits_type">
|
||||
<link rel="next" href="wait/overload1.html" title="basic_deadline_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_deadline_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_deadline_timer.wait"></a><a class="link" href="wait.html" title="basic_deadline_timer::wait">basic_deadline_timer::wait</a>
|
||||
</h4></div></div></div>
|
||||
<p>
|
||||
<a class="indexterm" name="asio.indexterm.basic_deadline_timer.wait"></a>
|
||||
Perform
|
||||
a blocking wait on the timer.
|
||||
</p>
|
||||
<pre class="programlisting">void <a class="link" href="wait/overload1.html" title="basic_deadline_timer::wait (1 of 2 overloads)">wait</a>();
|
||||
<span class="emphasis"><em>» <a class="link" href="wait/overload1.html" title="basic_deadline_timer::wait (1 of 2 overloads)">more...</a></em></span>
|
||||
|
||||
void <a class="link" href="wait/overload2.html" title="basic_deadline_timer::wait (2 of 2 overloads)">wait</a>(
|
||||
asio::error_code & ec);
|
||||
<span class="emphasis"><em>» <a class="link" href="wait/overload2.html" title="basic_deadline_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_deadline_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_deadline_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_deadline_timer::wait">
|
||||
<link rel="prev" href="../wait.html" title="basic_deadline_timer::wait">
|
||||
<link rel="next" href="overload2.html" title="basic_deadline_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_deadline_timer.wait.overload1"></a><a class="link" href="overload1.html" title="basic_deadline_timer::wait (1 of 2 overloads)">basic_deadline_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_deadline_timer.wait.overload1.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.wait.overload1.exceptions"></a></span><a class="link" href="overload1.html#asio.reference.basic_deadline_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_deadline_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_deadline_timer::wait">
|
||||
<link rel="prev" href="overload1.html" title="basic_deadline_timer::wait (1 of 2 overloads)">
|
||||
<link rel="next" href="../_basic_deadline_timer.html" title="basic_deadline_timer::~basic_deadline_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_deadline_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_deadline_timer.wait.overload2"></a><a class="link" href="overload2.html" title="basic_deadline_timer::wait (2 of 2 overloads)">basic_deadline_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 & 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_deadline_timer.wait.overload2.h0"></a>
|
||||
<span><a name="asio.reference.basic_deadline_timer.wait.overload2.parameters"></a></span><a class="link" href="overload2.html#asio.reference.basic_deadline_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_deadline_timer.html"><img src="../../../../next.png" alt="Next"></a>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in new issue
Block a user