doc/html/boost_asio/reference/basic_deadline_timer/cancel/overload2.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_deadline_timer::cancel (2 of 2 overloads)</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
   7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../cancel.html" title="basic_deadline_timer::cancel">
   9 <link rel="prev" href="overload1.html" title="basic_deadline_timer::cancel (1 of 2 overloads)">
  10 <link rel="next" href="../cancel_one.html" title="basic_deadline_timer::cancel_one">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <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>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <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
  28           (2 of 2 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Cancel any asynchronous operations that are waiting on the timer.
  32           </p>
  33 <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>
  34     <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">&amp;</span> <span class="identifier">ec</span><span class="special">);</span>
  35 </pre>
  36 <p>
  37             This function forces the completion of any pending asynchronous wait
  38             operations against the timer. The handler for each cancelled operation
  39             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>
  40             error code.
  41           </p>
  42 <p>
  43             Cancelling the timer does not change the expiry time.
  44           </p>
  45 <h6>
  46 <a name="boost_asio.reference.basic_deadline_timer.cancel.overload2.h0"></a>
  47             <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>
  48           </h6>
  49 <div class="variablelist">
  50 <p class="title"><b></b></p>
  51 <dl class="variablelist">
  52 <dt><span class="term">ec</span></dt>
  53 <dd><p>
  54                   Set to indicate what error occurred, if any.
  55                 </p></dd>
  56 </dl>
  57 </div>
  58 <h6>
  59 <a name="boost_asio.reference.basic_deadline_timer.cancel.overload2.h1"></a>
  60             <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
  61             Value</a>
  62           </h6>
  63 <p>
  64             The number of asynchronous operations that were cancelled.
  65           </p>
  66 <h6>
  67 <a name="boost_asio.reference.basic_deadline_timer.cancel.overload2.h2"></a>
  68             <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>
  69           </h6>
  70 <p>
  71             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
  72             wait operations will:
  73           </p>
  74 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  75 <li class="listitem">
  76                 have already been invoked; or
  77               </li>
  78 <li class="listitem">
  79                 have been queued for invocation in the near future.
  80               </li>
  81 </ul></div>
  82 <p>
  83             These handlers can no longer be cancelled, and therefore are passed an
  84             error code that indicates the successful completion of the wait operation.
  85           </p>
  86 </div>
  87 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  88 <td align="left"></td>
  89 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  90         Distributed under the Boost Software License, Version 1.0. (See accompanying
  91         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>)
  92       </p>
  93 </div></td>
  94 </tr></table>
  95 <hr>
  96 <div class="spirit-nav">
  97 <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>
  98 </div>
  99 </body>
 100 </html>