doc/html/boost_asio/reference/basic_deadline_timer/expires_from_now/overload3.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_deadline_timer::expires_from_now (3 of 3 overloads)</title>
   5 <link rel="stylesheet" href="../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../../boost_asio.html" title="Boost.Asio">
   8 <link rel="up" href="../expires_from_now.html" title="basic_deadline_timer::expires_from_now">
   9 <link rel="prev" href="overload2.html" title="basic_deadline_timer::expires_from_now (2 of 3 overloads)">
  10 <link rel="next" href="../get_implementation.html" title="basic_deadline_timer::get_implementation">
  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="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>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="boost_asio.reference.basic_deadline_timer.expires_from_now.overload3"></a><a class="link" href="overload3.html" title="basic_deadline_timer::expires_from_now (3 of 3 overloads)">basic_deadline_timer::expires_from_now
  28           (3 of 3 overloads)</a>
  29 </h5></div></div></div>
  30 <p>
  31             Set the timer's expiry time relative to now.
  32           </p>
  33 <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>
  34     <span class="keyword">const</span> <span class="identifier">duration_type</span> <span class="special">&amp;</span> <span class="identifier">expiry_time</span><span class="special">,</span>
  35     <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>
  36 </pre>
  37 <p>
  38             This function sets the expiry time. Any pending asynchronous wait operations
  39             will be cancelled. The handler for each cancelled operation will be invoked
  40             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.
  41           </p>
  42 <h6>
  43 <a name="boost_asio.reference.basic_deadline_timer.expires_from_now.overload3.h0"></a>
  44             <span class="phrase"><a name="boost_asio.reference.basic_deadline_timer.expires_from_now.overload3.parameters"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_deadline_timer.expires_from_now.overload3.parameters">Parameters</a>
  45           </h6>
  46 <div class="variablelist">
  47 <p class="title"><b></b></p>
  48 <dl class="variablelist">
  49 <dt><span class="term">expiry_time</span></dt>
  50 <dd><p>
  51                   The expiry time to be used for the timer.
  52                 </p></dd>
  53 <dt><span class="term">ec</span></dt>
  54 <dd><p>
  55                   Set to indicate what error occurred, if any.
  56                 </p></dd>
  57 </dl>
  58 </div>
  59 <h6>
  60 <a name="boost_asio.reference.basic_deadline_timer.expires_from_now.overload3.h1"></a>
  61             <span class="phrase"><a name="boost_asio.reference.basic_deadline_timer.expires_from_now.overload3.return_value"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_deadline_timer.expires_from_now.overload3.return_value">Return
  62             Value</a>
  63           </h6>
  64 <p>
  65             The number of asynchronous operations that were cancelled.
  66           </p>
  67 <h6>
  68 <a name="boost_asio.reference.basic_deadline_timer.expires_from_now.overload3.h2"></a>
  69             <span class="phrase"><a name="boost_asio.reference.basic_deadline_timer.expires_from_now.overload3.remarks"></a></span><a class="link" href="overload3.html#boost_asio.reference.basic_deadline_timer.expires_from_now.overload3.remarks">Remarks</a>
  70           </h6>
  71 <p>
  72             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
  73             wait operations will:
  74           </p>
  75 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  76 <li class="listitem">
  77                 have already been invoked; or
  78               </li>
  79 <li class="listitem">
  80                 have been queued for invocation in the near future.
  81               </li>
  82 </ul></div>
  83 <p>
  84             These handlers can no longer be cancelled, and therefore are passed an
  85             error code that indicates the successful completion of the wait operation.
  86           </p>
  87 </div>
  88 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  89 <td align="left"></td>
  90 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
  91         Distributed under the Boost Software License, Version 1.0. (See accompanying
  92         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>)
  93       </p>
  94 </div></td>
  95 </tr></table>
  96 <hr>
  97 <div class="spirit-nav">
  98 <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>
  99 </div>
 100 </body>
 101 </html>