| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>basic_deadline_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.75.2"> |
| <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="../cancel.html" title="basic_deadline_timer::cancel"> |
| <link rel="next" href="overload2.html" title="basic_deadline_timer::cancel (2 of 2 overloads)"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="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_deadline_timer.cancel.overload1"></a><a class="link" href="overload1.html" title="basic_deadline_timer::cancel (1 of 2 overloads)">basic_deadline_timer::cancel |
| (1 of 2 overloads)</a> |
| </h5></div></div></div> |
| <p> |
| Cancel any asynchronous operations that are waiting on the timer. |
| </p> |
| <pre class="programlisting"><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> |
| <a name="boost_asio.reference.basic_deadline_timer.cancel.overload1.return_value"></a><h6> |
| <a name="id933440"></a> |
| <a class="link" href="overload1.html#boost_asio.reference.basic_deadline_timer.cancel.overload1.return_value">Return |
| Value</a> |
| </h6> |
| <p> |
| The number of asynchronous operations that were cancelled. |
| </p> |
| <a name="boost_asio.reference.basic_deadline_timer.cancel.overload1.exceptions"></a><h6> |
| <a name="id933468"></a> |
| <a class="link" href="overload1.html#boost_asio.reference.basic_deadline_timer.cancel.overload1.exceptions">Exceptions</a> |
| </h6> |
| <div class="variablelist"> |
| <p class="title"><b></b></p> |
| <dl> |
| <dt><span class="term">boost::system::system_error</span></dt> |
| <dd><p> |
| Thrown on failure. |
| </p></dd> |
| </dl> |
| </div> |
| <a name="boost_asio.reference.basic_deadline_timer.cancel.overload1.remarks"></a><h6> |
| <a name="id933511"></a> |
| <a class="link" href="overload1.html#boost_asio.reference.basic_deadline_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" 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 - 2010 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> |
