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_deadline_timer/cancel/overload2.html | |
| 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_deadline_timer/cancel/overload2.html')
| -rw-r--r-- | doc/html/boost_asio/reference/basic_deadline_timer/cancel/overload2.html | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/doc/html/boost_asio/reference/basic_deadline_timer/cancel/overload2.html b/doc/html/boost_asio/reference/basic_deadline_timer/cancel/overload2.html new file mode 100644 index 0000000000..c1c85b0449 --- /dev/null +++ b/doc/html/boost_asio/reference/basic_deadline_timer/cancel/overload2.html @@ -0,0 +1,100 @@ +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> +<title>basic_deadline_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_deadline_timer::cancel"> +<link rel="prev" href="overload1.html" title="basic_deadline_timer::cancel (1 of 2 overloads)"> +<link rel="next" href="../cancel_one.html" title="basic_deadline_timer::cancel_one"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table cellpadding="2" width="100%"><tr> +<td valign="top"><img alt="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_deadline_timer.cancel.overload2"></a><a class="link" href="overload2.html" title="basic_deadline_timer::cancel (2 of 2 overloads)">basic_deadline_timer::cancel + (2 of 2 overloads)</a> +</h5></div></div></div> +<p> + Cancel any asynchronous operations that are waiting on the timer. + </p> +<pre class="programlisting"><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_deadline_timer.cancel.overload2.h0"></a> + <span class="phrase"><a name="boost_asio.reference.basic_deadline_timer.cancel.overload2.parameters"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_deadline_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_deadline_timer.cancel.overload2.h1"></a> + <span class="phrase"><a name="boost_asio.reference.basic_deadline_timer.cancel.overload2.return_value"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_deadline_timer.cancel.overload2.return_value">Return + Value</a> + </h6> +<p> + The number of asynchronous operations that were cancelled. + </p> +<h6> +<a name="boost_asio.reference.basic_deadline_timer.cancel.overload2.h2"></a> + <span class="phrase"><a name="boost_asio.reference.basic_deadline_timer.cancel.overload2.remarks"></a></span><a class="link" href="overload2.html#boost_asio.reference.basic_deadline_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> |