diff options
author | DongHun Kwak <dh0128.kwak@samsung.com> | 2017-09-13 11:08:07 +0900 |
---|---|---|
committer | DongHun Kwak <dh0128.kwak@samsung.com> | 2017-09-13 11:09:00 +0900 |
commit | b5c87084afaef42b2d058f68091be31988a6a874 (patch) | |
tree | adef9a65870a41181687e11d57fdf98e7629de3c /doc/html/boost_asio/reference/basic_waitable_timer | |
parent | 34bd32e225e2a8a94104489b31c42e5801cc1f4a (diff) | |
download | boost-b5c87084afaef42b2d058f68091be31988a6a874.tar.gz boost-b5c87084afaef42b2d058f68091be31988a6a874.tar.bz2 boost-b5c87084afaef42b2d058f68091be31988a6a874.zip |
Imported Upstream version 1.64.0upstream/1.64.0
Change-Id: Id9212edd016dd55f21172c427aa7894d1d24148b
Signed-off-by: DongHun Kwak <dh0128.kwak@samsung.com>
Diffstat (limited to 'doc/html/boost_asio/reference/basic_waitable_timer')
37 files changed, 2587 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/async_wait.html b/doc/html/boost_asio/reference/basic_waitable_timer/async_wait.html new file mode 100644 index 0000000000..2a0d552152 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/async_wait.html @@ -0,0 +1,96 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::async_wait</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="next" href="basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_waitable_timer.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.async_wait"></a><a class="link" href="async_wait.html" title="basic_waitable_timer::async_wait">basic_waitable_timer::async_wait</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp130858832"></a> +Start an asynchronous wait on the timer. + </p> +<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> + <span class="keyword">typename</span> <a class="link" href="../WaitHandler.html" title="Wait handler requirements">WaitHandler</a><span class="special">></span> +<a class="link" href="../asynchronous_operations.html#boost_asio.reference.asynchronous_operations.return_type_of_an_initiating_function"><span class="emphasis"><em>void-or-deduced</em></span></a> <span class="identifier">async_wait</span><span class="special">(</span> + <span class="identifier">WaitHandler</span> <span class="identifier">handler</span><span class="special">);</span> +</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"><span class="identifier">async_wait</span><span class="special">()</span></code>, the supplied handler will be called + exactly once. The handler will be called when: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>. + </li> +</ul></div> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.async_wait.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.async_wait.parameters"></a></span><a class="link" href="async_wait.html#boost_asio.reference.basic_waitable_timer.async_wait.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<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"><span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">error</span> <span class="comment">// Result of operation.</span> +<span class="special">);</span> +</pre> +<p> + Regardless of whether the asynchronous operation completes immediately + or not, the handler will not be invoked from within this function. + Invocation of the handler will be performed in a manner equivalent + to using <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span><span class="special">::</span><span class="identifier">post</span><span class="special">()</span></code>. + </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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_waitable_timer.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer.html b/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer.html new file mode 100644 index 0000000000..2e13e4be33 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::basic_waitable_timer</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="async_wait.html" title="basic_waitable_timer::async_wait"> +<link rel="next" href="basic_waitable_timer/overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 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="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="async_wait.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_waitable_timer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer"></a><a class="link" href="basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer">basic_waitable_timer::basic_waitable_timer</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp130899328"></a> +Constructor. + </p> +<pre class="programlisting"><span class="keyword">explicit</span> <a class="link" href="basic_waitable_timer/overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 3 overloads)">basic_waitable_timer</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Constructor to set a particular expiry time as an absolute time. + </p> +<pre class="programlisting"><a class="link" href="basic_waitable_timer/overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 3 overloads)">basic_waitable_timer</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">time_point</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Constructor to set a particular expiry time relative to now. + </p> +<pre class="programlisting"><a class="link" href="basic_waitable_timer/overload3.html" title="basic_waitable_timer::basic_waitable_timer (3 of 3 overloads)">basic_waitable_timer</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">duration</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="basic_waitable_timer/overload3.html" title="basic_waitable_timer::basic_waitable_timer (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-2017 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="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="basic_waitable_timer/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer/overload1.html b/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer/overload1.html new file mode 100644 index 0000000000..0e1d1bb683 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer/overload1.html @@ -0,0 +1,72 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::basic_waitable_timer (1 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer"> +<link rel="prev" href="../basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer"> +<link rel="next" href="overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 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="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../basic_waitable_timer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 3 overloads)">basic_waitable_timer::basic_waitable_timer + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + Constructor. + </p> +<pre class="programlisting"><span class="identifier">basic_waitable_timer</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">);</span> +</pre> +<p> + This constructor creates a timer without setting an expiry time. The + <code class="computeroutput"><span class="identifier">expires_at</span><span class="special">()</span></code> + or <code class="computeroutput"><span class="identifier">expires_from_now</span><span class="special">()</span></code> + functions must be called to set an expiry time before the timer can be + waited on. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload1.parameters"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload1.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the timer will use 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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../basic_waitable_timer.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer/overload2.html b/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer/overload2.html new file mode 100644 index 0000000000..0711da28fe --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer/overload2.html @@ -0,0 +1,74 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::basic_waitable_timer (2 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer"> +<link rel="prev" href="overload1.html" title="basic_waitable_timer::basic_waitable_timer (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="basic_waitable_timer::basic_waitable_timer (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="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 3 overloads)">basic_waitable_timer::basic_waitable_timer + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + Constructor to set a particular expiry time as an absolute time. + </p> +<pre class="programlisting"><span class="identifier">basic_waitable_timer</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">time_point</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">);</span> +</pre> +<p> + This constructor creates a timer and sets the expiry time. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the timer will use 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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer/overload3.html b/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer/overload3.html new file mode 100644 index 0000000000..828f066bdc --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/basic_waitable_timer/overload3.html @@ -0,0 +1,73 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::basic_waitable_timer (3 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer::basic_waitable_timer"> +<link rel="prev" href="overload2.html" title="basic_waitable_timer::basic_waitable_timer (2 of 3 overloads)"> +<link rel="next" href="../cancel.html" title="basic_waitable_timer::cancel"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../cancel.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload3"></a><a class="link" href="overload3.html" title="basic_waitable_timer::basic_waitable_timer (3 of 3 overloads)">basic_waitable_timer::basic_waitable_timer + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + Constructor to set a particular expiry time relative to now. + </p> +<pre class="programlisting"><span class="identifier">basic_waitable_timer</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">io_service</span><span class="special">,</span> + <span class="keyword">const</span> <span class="identifier">duration</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">);</span> +</pre> +<p> + This constructor creates a timer and sets the expiry time. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload3.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_waitable_timer.basic_waitable_timer.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">io_service</span></dt> +<dd><p> + The <a class="link" href="../../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that + the timer will use 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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../cancel.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/cancel.html b/doc/html/boost_asio/reference/basic_waitable_timer/cancel.html new file mode 100644 index 0000000000..25a8ec062c --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/cancel.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::cancel</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="basic_waitable_timer/overload3.html" title="basic_waitable_timer::basic_waitable_timer (3 of 3 overloads)"> +<link rel="next" href="cancel/overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="basic_waitable_timer/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.cancel"></a><a class="link" href="cancel.html" title="basic_waitable_timer::cancel">basic_waitable_timer::cancel</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131000080"></a> +Cancel any asynchronous operations that are waiting + on the timer. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="cancel/overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)">cancel</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="cancel/overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="cancel/overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)">cancel</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="cancel/overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="basic_waitable_timer/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cancel/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/cancel/overload1.html b/doc/html/boost_asio/reference/basic_waitable_timer/cancel/overload1.html new file mode 100644 index 0000000000..0b3950cab3 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/cancel/overload1.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::cancel (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../cancel.html" title="basic_waitable_timer::cancel"> +<link rel="prev" href="../cancel.html" title="basic_waitable_timer::cancel"> +<link rel="next" href="overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../cancel.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.cancel.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)">basic_waitable_timer::cancel + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Cancel any asynchronous operations that are waiting on the timer. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">cancel</span><span class="special">();</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> + error code. + </p> +<p> + Cancelling the timer does not change the expiry time. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_waitable_timer.cancel.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of asynchronous operations that were cancelled. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_waitable_timer.cancel.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel.overload1.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_waitable_timer.cancel.overload1.remarks">Remarks</a> + </h6> +<p> + If the timer has already expired when <code class="computeroutput"><span class="identifier">cancel</span><span class="special">()</span></code> is called, then the handlers for asynchronous + wait operations will: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/cancel/overload2.html b/doc/html/boost_asio/reference/basic_waitable_timer/cancel/overload2.html new file mode 100644 index 0000000000..c21ee9ff85 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/cancel/overload2.html @@ -0,0 +1,100 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::cancel (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../cancel.html" title="basic_waitable_timer::cancel"> +<link rel="prev" href="overload1.html" title="basic_waitable_timer::cancel (1 of 2 overloads)"> +<link rel="next" href="../cancel_one.html" title="basic_waitable_timer::cancel_one"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../cancel_one.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.cancel.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)">basic_waitable_timer::cancel + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Cancel any asynchronous operations that are waiting on the timer. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">cancel</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> + error code. + </p> +<p> + Cancelling the timer does not change the expiry time. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.cancel.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.cancel.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of asynchronous operations that were cancelled. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.cancel.overload2.remarks">Remarks</a> + </h6> +<p> + If the timer has already expired when <code class="computeroutput"><span class="identifier">cancel</span><span class="special">()</span></code> is called, then the handlers for asynchronous + wait operations will: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../cancel_one.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/cancel_one.html b/doc/html/boost_asio/reference/basic_waitable_timer/cancel_one.html new file mode 100644 index 0000000000..c1ee649e6f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/cancel_one.html @@ -0,0 +1,55 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::cancel_one</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="cancel/overload2.html" title="basic_waitable_timer::cancel (2 of 2 overloads)"> +<link rel="next" href="cancel_one/overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="cancel/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cancel_one/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.cancel_one"></a><a class="link" href="cancel_one.html" title="basic_waitable_timer::cancel_one">basic_waitable_timer::cancel_one</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131078912"></a> +Cancels one asynchronous operation that is + waiting on the timer. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="cancel_one/overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)">cancel_one</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="cancel_one/overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)">more...</a></em></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="cancel_one/overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)">cancel_one</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="cancel_one/overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cancel_one/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/cancel_one/overload1.html b/doc/html/boost_asio/reference/basic_waitable_timer/cancel_one/overload1.html new file mode 100644 index 0000000000..10bb5b4adf --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/cancel_one/overload1.html @@ -0,0 +1,99 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::cancel_one (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../cancel_one.html" title="basic_waitable_timer::cancel_one"> +<link rel="prev" href="../cancel_one.html" title="basic_waitable_timer::cancel_one"> +<link rel="next" href="overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../cancel_one.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)">basic_waitable_timer::cancel_one + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Cancels one asynchronous operation that is waiting on the timer. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">cancel_one</span><span class="special">();</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error code. + </p> +<p> + Cancelling the timer does not change the expiry time. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload1.return_value"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_waitable_timer.cancel_one.overload1.return_value">Return + Value</a> + </h6> +<p> + The number of asynchronous operations that were cancelled. That is, either + 0 or 1. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload1.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_waitable_timer.cancel_one.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload1.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload1.remarks"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_waitable_timer.cancel_one.overload1.remarks">Remarks</a> + </h6> +<p> + If the timer has already expired when <code class="computeroutput"><span class="identifier">cancel_one</span><span class="special">()</span></code> is called, then the handlers for asynchronous + wait operations will: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/cancel_one/overload2.html b/doc/html/boost_asio/reference/basic_waitable_timer/cancel_one/overload2.html new file mode 100644 index 0000000000..f533140602 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/cancel_one/overload2.html @@ -0,0 +1,100 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::cancel_one (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../cancel_one.html" title="basic_waitable_timer::cancel_one"> +<link rel="prev" href="overload1.html" title="basic_waitable_timer::cancel_one (1 of 2 overloads)"> +<link rel="next" href="../clock_type.html" title="basic_waitable_timer::clock_type"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../clock_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)">basic_waitable_timer::cancel_one + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Cancels one asynchronous operation that is waiting on the timer. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">cancel_one</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error code. + </p> +<p> + Cancelling the timer does not change the expiry time. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.cancel_one.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">ec</span></dt> +<dd><p> + Set to indicate what error occurred, if any. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.cancel_one.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of asynchronous operations that were cancelled. That is, either + 0 or 1. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.cancel_one.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.cancel_one.overload2.remarks">Remarks</a> + </h6> +<p> + If the timer has already expired when <code class="computeroutput"><span class="identifier">cancel_one</span><span class="special">()</span></code> is called, then the handlers for asynchronous + wait operations will: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cancel_one.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../clock_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/clock_type.html b/doc/html/boost_asio/reference/basic_waitable_timer/clock_type.html new file mode 100644 index 0000000000..207b1faf1e --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/clock_type.html @@ -0,0 +1,59 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::clock_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="cancel_one/overload2.html" title="basic_waitable_timer::cancel_one (2 of 2 overloads)"> +<link rel="next" href="duration.html" title="basic_waitable_timer::duration"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="cancel_one/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="duration.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.clock_type"></a><a class="link" href="clock_type.html" title="basic_waitable_timer::clock_type">basic_waitable_timer::clock_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131158496"></a> +The clock type. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">Clock</span> <span class="identifier">clock_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.clock_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.clock_type.requirements"></a></span><a class="link" href="clock_type.html#boost_asio.reference.basic_waitable_timer.clock_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_waitable_timer.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/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-2017 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="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="duration.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/duration.html b/doc/html/boost_asio/reference/basic_waitable_timer/duration.html new file mode 100644 index 0000000000..72b7ab673f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/duration.html @@ -0,0 +1,59 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::duration</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="clock_type.html" title="basic_waitable_timer::clock_type"> +<link rel="next" href="expires_at.html" title="basic_waitable_timer::expires_at"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="clock_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="expires_at.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.duration"></a><a class="link" href="duration.html" title="basic_waitable_timer::duration">basic_waitable_timer::duration</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131170912"></a> +The duration type of the clock. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">clock_type</span><span class="special">::</span><span class="identifier">duration</span> <span class="identifier">duration</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.duration.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.duration.requirements"></a></span><a class="link" href="duration.html#boost_asio.reference.basic_waitable_timer.duration.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_waitable_timer.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="clock_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="expires_at.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/expires_at.html b/doc/html/boost_asio/reference/basic_waitable_timer/expires_at.html new file mode 100644 index 0000000000..979fc7c76f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/expires_at.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::expires_at</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="duration.html" title="basic_waitable_timer::duration"> +<link rel="next" href="expires_at/overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="duration.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="expires_at/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.expires_at"></a><a class="link" href="expires_at.html" title="basic_waitable_timer::expires_at">basic_waitable_timer::expires_at</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131184304"></a> +Get the timer's expiry time as an absolute + time. + </p> +<pre class="programlisting"><span class="identifier">time_point</span> <a class="link" href="expires_at/overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)">expires_at</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="expires_at/overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Set the timer's expiry time as an absolute time. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="expires_at/overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)">expires_at</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">time_point</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="expires_at/overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)">more...</a></em></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="expires_at/overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)">expires_at</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">time_point</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="expires_at/overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="duration.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="expires_at/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/expires_at/overload1.html b/doc/html/boost_asio/reference/basic_waitable_timer/expires_at/overload1.html new file mode 100644 index 0000000000..b40a1cdd01 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/expires_at/overload1.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::expires_at (1 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../expires_at.html" title="basic_waitable_timer::expires_at"> +<link rel="prev" href="../expires_at.html" title="basic_waitable_timer::expires_at"> +<link rel="next" href="overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../expires_at.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)">basic_waitable_timer::expires_at + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + Get the timer's expiry time as an absolute time. + </p> +<pre class="programlisting"><span class="identifier">time_point</span> <span class="identifier">expires_at</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/expires_at/overload2.html b/doc/html/boost_asio/reference/basic_waitable_timer/expires_at/overload2.html new file mode 100644 index 0000000000..8d13c49e2d --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/expires_at/overload2.html @@ -0,0 +1,109 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::expires_at (2 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../expires_at.html" title="basic_waitable_timer::expires_at"> +<link rel="prev" href="overload1.html" title="basic_waitable_timer::expires_at (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)">basic_waitable_timer::expires_at + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + Set the timer's expiry time as an absolute time. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">expires_at</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">time_point</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">);</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error code. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_at.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<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="boost_asio.reference.basic_waitable_timer.expires_at.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_at.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of asynchronous operations that were cancelled. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_at.overload2.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.h3"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_at.overload2.remarks">Remarks</a> + </h6> +<p> + If the timer has already expired when <code class="computeroutput"><span class="identifier">expires_at</span><span class="special">()</span></code> is called, then the handlers for asynchronous + wait operations will: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/expires_at/overload3.html b/doc/html/boost_asio/reference/basic_waitable_timer/expires_at/overload3.html new file mode 100644 index 0000000000..49b2c6b12f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/expires_at/overload3.html @@ -0,0 +1,101 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::expires_at (3 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../expires_at.html" title="basic_waitable_timer::expires_at"> +<link rel="prev" href="overload2.html" title="basic_waitable_timer::expires_at (2 of 3 overloads)"> +<link rel="next" href="../expires_from_now.html" title="basic_waitable_timer::expires_from_now"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../expires_from_now.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload3"></a><a class="link" href="overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)">basic_waitable_timer::expires_at + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + Set the timer's expiry time as an absolute time. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">expires_at</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">time_point</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error code. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload3.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_waitable_timer.expires_at.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<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="boost_asio.reference.basic_waitable_timer.expires_at.overload3.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload3.return_value"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_waitable_timer.expires_at.overload3.return_value">Return + Value</a> + </h6> +<p> + The number of asynchronous operations that were cancelled. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_at.overload3.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_at.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_waitable_timer.expires_at.overload3.remarks">Remarks</a> + </h6> +<p> + If the timer has already expired when <code class="computeroutput"><span class="identifier">expires_at</span><span class="special">()</span></code> is called, then the handlers for asynchronous + wait operations will: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_at.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../expires_from_now.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now.html b/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now.html new file mode 100644 index 0000000000..37d14e7323 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::expires_from_now</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="expires_at/overload3.html" title="basic_waitable_timer::expires_at (3 of 3 overloads)"> +<link rel="next" href="expires_from_now/overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="expires_at/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="expires_from_now/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.expires_from_now"></a><a class="link" href="expires_from_now.html" title="basic_waitable_timer::expires_from_now">basic_waitable_timer::expires_from_now</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131295152"></a> +Get the timer's expiry time relative + to now. + </p> +<pre class="programlisting"><span class="identifier">duration</span> <a class="link" href="expires_from_now/overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)">expires_from_now</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="expires_from_now/overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)">more...</a></em></span> +</pre> +<p> + Set the timer's expiry time relative to now. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="expires_from_now/overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)">expires_from_now</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">duration</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="expires_from_now/overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)">more...</a></em></span> + +<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="expires_from_now/overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)">expires_from_now</a><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">duration</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="expires_from_now/overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="expires_from_now/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now/overload1.html b/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now/overload1.html new file mode 100644 index 0000000000..b70f168c02 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now/overload1.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::expires_from_now (1 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../expires_from_now.html" title="basic_waitable_timer::expires_from_now"> +<link rel="prev" href="../expires_from_now.html" title="basic_waitable_timer::expires_from_now"> +<link rel="next" href="overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../expires_from_now.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)">basic_waitable_timer::expires_from_now + (1 of 3 overloads)</a> +</h5></div></div></div> +<p> + Get the timer's expiry time relative to now. + </p> +<pre class="programlisting"><span class="identifier">duration</span> <span class="identifier">expires_from_now</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> +</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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now/overload2.html b/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now/overload2.html new file mode 100644 index 0000000000..56503bd39f --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now/overload2.html @@ -0,0 +1,109 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::expires_from_now (2 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../expires_from_now.html" title="basic_waitable_timer::expires_from_now"> +<link rel="prev" href="overload1.html" title="basic_waitable_timer::expires_from_now (1 of 3 overloads)"> +<link rel="next" href="overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)">basic_waitable_timer::expires_from_now + (2 of 3 overloads)</a> +</h5></div></div></div> +<p> + Set the timer's expiry time relative to now. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">expires_from_now</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">duration</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">);</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error code. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<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="boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of asynchronous operations that were cancelled. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.exceptions"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::system_error</span></dt> +<dd><p> + Thrown on failure. + </p></dd> +</dl> +</div> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.h3"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.expires_from_now.overload2.remarks">Remarks</a> + </h6> +<p> + If the timer has already expired when <code class="computeroutput"><span class="identifier">expires_from_now</span><span class="special">()</span></code> is called, then the handlers for asynchronous + wait operations will: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload3.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now/overload3.html b/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now/overload3.html new file mode 100644 index 0000000000..e51598f383 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/expires_from_now/overload3.html @@ -0,0 +1,101 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::expires_from_now (3 of 3 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../expires_from_now.html" title="basic_waitable_timer::expires_from_now"> +<link rel="prev" href="overload2.html" title="basic_waitable_timer::expires_from_now (2 of 3 overloads)"> +<link rel="next" href="../get_implementation.html" title="basic_waitable_timer::get_implementation"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload2.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../get_implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload3"></a><a class="link" href="overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)">basic_waitable_timer::expires_from_now + (3 of 3 overloads)</a> +</h5></div></div></div> +<p> + Set the timer's expiry time relative to now. + </p> +<pre class="programlisting"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">expires_from_now</span><span class="special">(</span> + <span class="keyword">const</span> <span class="identifier">duration</span> <span class="special">&</span> <span class="identifier">expiry_time</span><span class="special">,</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</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"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code> error code. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload3.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_waitable_timer.expires_from_now.overload3.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<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="boost_asio.reference.basic_waitable_timer.expires_from_now.overload3.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload3.return_value"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_waitable_timer.expires_from_now.overload3.return_value">Return + Value</a> + </h6> +<p> + The number of asynchronous operations that were cancelled. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload3.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.expires_from_now.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_waitable_timer.expires_from_now.overload3.remarks">Remarks</a> + </h6> +<p> + If the timer has already expired when <code class="computeroutput"><span class="identifier">expires_from_now</span><span class="special">()</span></code> is called, then the handlers for asynchronous + wait operations will: + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../expires_from_now.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../get_implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/get_implementation.html b/doc/html/boost_asio/reference/basic_waitable_timer/get_implementation.html new file mode 100644 index 0000000000..0e2d8d8c80 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/get_implementation.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::get_implementation</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="expires_from_now/overload3.html" title="basic_waitable_timer::expires_from_now (3 of 3 overloads)"> +<link rel="next" href="get_implementation/overload1.html" title="basic_waitable_timer::get_implementation (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="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="expires_from_now/overload3.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_implementation/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.get_implementation"></a><a class="link" href="get_implementation.html" title="basic_waitable_timer::get_implementation">basic_waitable_timer::get_implementation</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131406368"></a> +Get the underlying implementation + of the I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="special">&</span> <a class="link" href="get_implementation/overload1.html" title="basic_waitable_timer::get_implementation (1 of 2 overloads)">get_implementation</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="get_implementation/overload1.html" title="basic_waitable_timer::get_implementation (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">const</span> <span class="identifier">implementation_type</span> <span class="special">&</span> <a class="link" href="get_implementation/overload2.html" title="basic_waitable_timer::get_implementation (2 of 2 overloads)">get_implementation</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_implementation/overload2.html" title="basic_waitable_timer::get_implementation (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-2017 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="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_implementation/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/get_implementation/overload1.html b/doc/html/boost_asio/reference/basic_waitable_timer/get_implementation/overload1.html new file mode 100644 index 0000000000..56147a5d36 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/get_implementation/overload1.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::get_implementation (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_implementation.html" title="basic_waitable_timer::get_implementation"> +<link rel="prev" href="../get_implementation.html" title="basic_waitable_timer::get_implementation"> +<link rel="next" href="overload2.html" title="basic_waitable_timer::get_implementation (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="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../get_implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.get_implementation.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::get_implementation (1 of 2 overloads)">basic_waitable_timer::get_implementation + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="special">&</span> <span class="identifier">get_implementation</span><span class="special">();</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-2017 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_implementation.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/get_implementation/overload2.html b/doc/html/boost_asio/reference/basic_waitable_timer/get_implementation/overload2.html new file mode 100644 index 0000000000..a4d1316621 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/get_implementation/overload2.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::get_implementation (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_implementation.html" title="basic_waitable_timer::get_implementation"> +<link rel="prev" href="overload1.html" title="basic_waitable_timer::get_implementation (1 of 2 overloads)"> +<link rel="next" href="../get_io_service.html" title="basic_waitable_timer::get_io_service"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../get_io_service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.get_implementation.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::get_implementation (2 of 2 overloads)">basic_waitable_timer::get_implementation + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the underlying implementation of the I/O object. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">implementation_type</span> <span class="special">&</span> <span class="identifier">get_implementation</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_implementation.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../get_io_service.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/get_io_service.html b/doc/html/boost_asio/reference/basic_waitable_timer/get_io_service.html new file mode 100644 index 0000000000..e5df80d769 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/get_io_service.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::get_io_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="get_implementation/overload2.html" title="basic_waitable_timer::get_implementation (2 of 2 overloads)"> +<link rel="next" href="get_service.html" title="basic_waitable_timer::get_service"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="get_implementation/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.get_io_service"></a><a class="link" href="get_io_service.html" title="basic_waitable_timer::get_io_service">basic_waitable_timer::get_io_service</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp131436672"></a> +Get the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> associated with the + object. + </p> +<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">io_service</span> <span class="special">&</span> <span class="identifier">get_io_service</span><span class="special">();</span> +</pre> +<p> + This function may be used to obtain the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the I/O + object uses to dispatch handlers for asynchronous operations. + </p> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.get_io_service.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.get_io_service.return_value"></a></span><a class="link" href="get_io_service.html#boost_asio.reference.basic_waitable_timer.get_io_service.return_value">Return + Value</a> + </h6> +<p> + A reference to the <a class="link" href="../io_service.html" title="io_service"><code class="computeroutput"><span class="identifier">io_service</span></code></a> object that the I/O + object will use to dispatch handlers. Ownership is not transferred to the + caller. + </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-2017 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_implementation/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/get_service.html b/doc/html/boost_asio/reference/basic_waitable_timer/get_service.html new file mode 100644 index 0000000000..8d2186fed5 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/get_service.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::get_service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="get_io_service.html" title="basic_waitable_timer::get_io_service"> +<link rel="next" href="get_service/overload1.html" title="basic_waitable_timer::get_service (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="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="get_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_service/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.get_service"></a><a class="link" href="get_service.html" title="basic_waitable_timer::get_service">basic_waitable_timer::get_service</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131455008"></a> +Get the service associated with the I/O + object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <a class="link" href="get_service/overload1.html" title="basic_waitable_timer::get_service (1 of 2 overloads)">get_service</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="get_service/overload1.html" title="basic_waitable_timer::get_service (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">const</span> <span class="identifier">service_type</span> <span class="special">&</span> <a class="link" href="get_service/overload2.html" title="basic_waitable_timer::get_service (2 of 2 overloads)">get_service</a><span class="special">()</span> <span class="keyword">const</span><span class="special">;</span> + <span class="emphasis"><em>» <a class="link" href="get_service/overload2.html" title="basic_waitable_timer::get_service (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-2017 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_io_service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="get_service/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/get_service/overload1.html b/doc/html/boost_asio/reference/basic_waitable_timer/get_service/overload1.html new file mode 100644 index 0000000000..8b0d8f4d75 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/get_service/overload1.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::get_service (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_service.html" title="basic_waitable_timer::get_service"> +<link rel="prev" href="../get_service.html" title="basic_waitable_timer::get_service"> +<link rel="next" href="overload2.html" title="basic_waitable_timer::get_service (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="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../get_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.get_service.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::get_service (1 of 2 overloads)">basic_waitable_timer::get_service + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the service associated with the I/O object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">get_service</span><span class="special">();</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-2017 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_service.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/get_service/overload2.html b/doc/html/boost_asio/reference/basic_waitable_timer/get_service/overload2.html new file mode 100644 index 0000000000..1172f05699 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/get_service/overload2.html @@ -0,0 +1,52 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::get_service (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../get_service.html" title="basic_waitable_timer::get_service"> +<link rel="prev" href="overload1.html" title="basic_waitable_timer::get_service (1 of 2 overloads)"> +<link rel="next" href="../implementation.html" title="basic_waitable_timer::implementation"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.get_service.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::get_service (2 of 2 overloads)">basic_waitable_timer::get_service + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + Get the service associated with the I/O object. + </p> +<pre class="programlisting"><span class="keyword">const</span> <span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">get_service</span><span class="special">()</span> <span class="keyword">const</span><span class="special">;</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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../get_service.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../implementation.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/implementation.html b/doc/html/boost_asio/reference/basic_waitable_timer/implementation.html new file mode 100644 index 0000000000..6337816d6e --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/implementation.html @@ -0,0 +1,53 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::implementation</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="get_service/overload2.html" title="basic_waitable_timer::get_service (2 of 2 overloads)"> +<link rel="next" href="implementation_type.html" title="basic_waitable_timer::implementation_type"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="get_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="implementation_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.implementation"></a><a class="link" href="implementation.html" title="basic_waitable_timer::implementation">basic_waitable_timer::implementation</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp131485136"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">get_implementation</span><span class="special">()</span></code>.) The underlying implementation of the + I/O object. + </p> +<pre class="programlisting"><span class="identifier">implementation_type</span> <span class="identifier">implementation</span><span class="special">;</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-2017 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_service/overload2.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="implementation_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/implementation_type.html b/doc/html/boost_asio/reference/basic_waitable_timer/implementation_type.html new file mode 100644 index 0000000000..94573bcaae --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/implementation_type.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::implementation_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="implementation.html" title="basic_waitable_timer::implementation"> +<link rel="next" href="service.html" title="basic_waitable_timer::service"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.implementation_type"></a><a class="link" href="implementation_type.html" title="basic_waitable_timer::implementation_type">basic_waitable_timer::implementation_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp131493792"></a> +The underlying implementation type + of I/O object. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">service_type</span><span class="special">::</span><span class="identifier">implementation_type</span> <span class="identifier">implementation_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.implementation_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.implementation_type.requirements"></a></span><a class="link" href="implementation_type.html#boost_asio.reference.basic_waitable_timer.implementation_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_waitable_timer.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/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-2017 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="implementation.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="service.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/service.html b/doc/html/boost_asio/reference/basic_waitable_timer/service.html new file mode 100644 index 0000000000..cfc579e165 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/service.html @@ -0,0 +1,60 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::service</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="implementation_type.html" title="basic_waitable_timer::implementation_type"> +<link rel="next" href="service_type.html" title="basic_waitable_timer::service_type"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="implementation_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="service_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.service"></a><a class="link" href="service.html" title="basic_waitable_timer::service">basic_waitable_timer::service</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp131508128"></a> +(Deprecated: Use <code class="computeroutput"><span class="identifier">get_service</span><span class="special">()</span></code>.) The service associated with the I/O + object. + </p> +<pre class="programlisting"><span class="identifier">service_type</span> <span class="special">&</span> <span class="identifier">service</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.service.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.service.remarks"></a></span><a class="link" href="service.html#boost_asio.reference.basic_waitable_timer.service.remarks">Remarks</a> + </h6> +<p> + Available only for services that do not support movability. + </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-2017 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="implementation_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="service_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/service_type.html b/doc/html/boost_asio/reference/basic_waitable_timer/service_type.html new file mode 100644 index 0000000000..85235f7bfc --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/service_type.html @@ -0,0 +1,63 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::service_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="service.html" title="basic_waitable_timer::service"> +<link rel="next" href="time_point.html" title="basic_waitable_timer::time_point"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="time_point.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.service_type"></a><a class="link" href="service_type.html" title="basic_waitable_timer::service_type">basic_waitable_timer::service_type</a> +</h4></div></div></div> +<p> + <span class="emphasis"><em>Inherited from basic_io_object.</em></span> + </p> +<p> + <a class="indexterm" name="idp131520640"></a> +The type of the service that will be used + to provide I/O operations. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">WaitableTimerService</span> <span class="identifier">service_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.service_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.service_type.requirements"></a></span><a class="link" href="service_type.html#boost_asio.reference.basic_waitable_timer.service_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_waitable_timer.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/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-2017 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="service.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="time_point.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/time_point.html b/doc/html/boost_asio/reference/basic_waitable_timer/time_point.html new file mode 100644 index 0000000000..5c563ff160 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/time_point.html @@ -0,0 +1,59 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::time_point</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="service_type.html" title="basic_waitable_timer::service_type"> +<link rel="next" href="traits_type.html" title="basic_waitable_timer::traits_type"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="service_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="traits_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.time_point"></a><a class="link" href="time_point.html" title="basic_waitable_timer::time_point">basic_waitable_timer::time_point</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131533120"></a> +The time point type of the clock. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">clock_type</span><span class="special">::</span><span class="identifier">time_point</span> <span class="identifier">time_point</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.time_point.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.time_point.requirements"></a></span><a class="link" href="time_point.html#boost_asio.reference.basic_waitable_timer.time_point.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_waitable_timer.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/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-2017 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="service_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="traits_type.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/traits_type.html b/doc/html/boost_asio/reference/basic_waitable_timer/traits_type.html new file mode 100644 index 0000000000..fb5207122a --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/traits_type.html @@ -0,0 +1,59 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::traits_type</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="time_point.html" title="basic_waitable_timer::time_point"> +<link rel="next" href="wait.html" title="basic_waitable_timer::wait"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="time_point.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wait.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.traits_type"></a><a class="link" href="traits_type.html" title="basic_waitable_timer::traits_type">basic_waitable_timer::traits_type</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131546384"></a> +The wait traits type. + </p> +<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">WaitTraits</span> <span class="identifier">traits_type</span><span class="special">;</span> +</pre> +<h6> +<a name="boost_asio.reference.basic_waitable_timer.traits_type.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.traits_type.requirements"></a></span><a class="link" href="traits_type.html#boost_asio.reference.basic_waitable_timer.traits_type.requirements">Requirements</a> + </h6> +<p> + <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/basic_waitable_timer.hpp</code> + </p> +<p> + <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/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-2017 Christopher M. Kohlhoff<p> + Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) + </p> +</div></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="time_point.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wait.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/wait.html b/doc/html/boost_asio/reference/basic_waitable_timer/wait.html new file mode 100644 index 0000000000..d95f42abb6 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/wait.html @@ -0,0 +1,54 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::wait</title> +<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../basic_waitable_timer.html" title="basic_waitable_timer"> +<link rel="prev" href="traits_type.html" title="basic_waitable_timer::traits_type"> +<link rel="next" href="wait/overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td> +<td align="center"><a href="../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="traits_type.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wait/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h4 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.wait"></a><a class="link" href="wait.html" title="basic_waitable_timer::wait">basic_waitable_timer::wait</a> +</h4></div></div></div> +<p> + <a class="indexterm" name="idp131558816"></a> +Perform a blocking wait on the timer. + </p> +<pre class="programlisting"><span class="keyword">void</span> <a class="link" href="wait/overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)">wait</a><span class="special">();</span> + <span class="emphasis"><em>» <a class="link" href="wait/overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)">more...</a></em></span> + +<span class="keyword">void</span> <a class="link" href="wait/overload2.html" title="basic_waitable_timer::wait (2 of 2 overloads)">wait</a><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> + <span class="emphasis"><em>» <a class="link" href="wait/overload2.html" title="basic_waitable_timer::wait (2 of 2 overloads)">more...</a></em></span> +</pre> +</div> +<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> +<td align="left"></td> +<td align="right"><div class="copyright-footer">Copyright © 2003-2017 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="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../basic_waitable_timer.html"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../boost_asio.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="wait/overload1.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/wait/overload1.html b/doc/html/boost_asio/reference/basic_waitable_timer/wait/overload1.html new file mode 100644 index 0000000000..7c477f7b13 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/wait/overload1.html @@ -0,0 +1,66 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::wait (1 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../wait.html" title="basic_waitable_timer::wait"> +<link rel="prev" href="../wait.html" title="basic_waitable_timer::wait"> +<link rel="next" href="overload2.html" title="basic_waitable_timer::wait (2 of 2 overloads)"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="../wait.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../wait.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.wait.overload1"></a><a class="link" href="overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)">basic_waitable_timer::wait + (1 of 2 overloads)</a> +</h5></div></div></div> +<p> + Perform a blocking wait on the timer. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">wait</span><span class="special">();</span> +</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="boost_asio.reference.basic_waitable_timer.wait.overload1.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.wait.overload1.exceptions"></a></span><a class="link" href="overload1.html#boost_asio.reference.basic_waitable_timer.wait.overload1.exceptions">Exceptions</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<dt><span class="term">boost::system::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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../wait.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="overload2.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> diff --git a/doc/html/boost_asio/reference/basic_waitable_timer/wait/overload2.html b/doc/html/boost_asio/reference/basic_waitable_timer/wait/overload2.html new file mode 100644 index 0000000000..ca6bfd1a8d --- /dev/null +++ b/doc/html/boost_asio/reference/basic_waitable_timer/wait/overload2.html @@ -0,0 +1,67 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_waitable_timer::wait (2 of 2 overloads)</title> +<link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> +<link rel="home" href="../../../../boost_asio.html" title="Boost.Asio"> +<link rel="up" href="../wait.html" title="basic_waitable_timer::wait"> +<link rel="prev" href="overload1.html" title="basic_waitable_timer::wait (1 of 2 overloads)"> +<link rel="next" href="../../basic_yield_context.html" title="basic_yield_context"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td> +<td align="center"><a href="../../../../../../index.html">Home</a></td> +<td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td> +<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> +<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> +<td align="center"><a href="../../../../../../more/index.htm">More</a></td> +</tr></table> +<hr> +<div class="spirit-nav"> +<a accesskey="p" href="overload1.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../wait.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../basic_yield_context.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +<div class="section"> +<div class="titlepage"><div><div><h5 class="title"> +<a name="boost_asio.reference.basic_waitable_timer.wait.overload2"></a><a class="link" href="overload2.html" title="basic_waitable_timer::wait (2 of 2 overloads)">basic_waitable_timer::wait + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Perform a blocking wait on the timer. + </p> +<pre class="programlisting"><span class="keyword">void</span> <span class="identifier">wait</span><span class="special">(</span> + <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span> <span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> +</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="boost_asio.reference.basic_waitable_timer.wait.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_waitable_timer.wait.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_waitable_timer.wait.overload2.parameters">Parameters</a> + </h6> +<div class="variablelist"> +<p class="title"><b></b></p> +<dl class="variablelist"> +<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-2017 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="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../wait.html"><img src="../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../../boost_asio.html"><img src="../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../../basic_yield_context.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a> +</div> +</body> +</html> |