doc/html/boost_asio/reference/deadline_timer_service.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>deadline_timer_service</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="../reference.html" title="Reference">
   9 <link rel="prev" href="deadline_timer.html" title="deadline_timer">
  10 <link rel="next" href="deadline_timer_service/async_wait.html" title="deadline_timer_service::async_wait">
  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="deadline_timer.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="deadline_timer_service/async_wait.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h3 class="title">
  27 <a name="boost_asio.reference.deadline_timer_service"></a><a class="link" href="deadline_timer_service.html" title="deadline_timer_service">deadline_timer_service</a>
  28 </h3></div></div></div>
  29 <p>
  30         Default service implementation for a timer.
  31       </p>
  32 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  33     <span class="keyword">typename</span> <span class="identifier">TimeType</span><span class="special">,</span>
  34     <span class="keyword">typename</span> <a class="link" href="TimeTraits.html" title="Time traits requirements">TimeTraits</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">time_traits</span><span class="special">&lt;</span><span class="identifier">TimeType</span><span class="special">&gt;&gt;</span>
  35 <span class="keyword">class</span> <span class="identifier">deadline_timer_service</span> <span class="special">:</span>
  36   <span class="keyword">public</span> <span class="identifier">io_service</span><span class="special">::</span><span class="identifier">service</span>
  37 </pre>
  38 <h5>
  39 <a name="boost_asio.reference.deadline_timer_service.h0"></a>
  40         <span class="phrase"><a name="boost_asio.reference.deadline_timer_service.types"></a></span><a class="link" href="deadline_timer_service.html#boost_asio.reference.deadline_timer_service.types">Types</a>
  41       </h5>
  42 <div class="informaltable"><table class="table">
  43 <colgroup>
  44 <col>
  45 <col>
  46 </colgroup>
  47 <thead><tr>
  48 <th>
  49                 <p>
  50                   Name
  51                 </p>
  52               </th>
  53 <th>
  54                 <p>
  55                   Description
  56                 </p>
  57               </th>
  58 </tr></thead>
  59 <tbody>
  60 <tr>
  61 <td>
  62                 <p>
  63                   <a class="link" href="deadline_timer_service/duration_type.html" title="deadline_timer_service::duration_type"><span class="bold"><strong>duration_type</strong></span></a>
  64                 </p>
  65               </td>
  66 <td>
  67                 <p>
  68                   The duration type.
  69                 </p>
  70               </td>
  71 </tr>
  72 <tr>
  73 <td>
  74                 <p>
  75                   <a class="link" href="deadline_timer_service/implementation_type.html" title="deadline_timer_service::implementation_type"><span class="bold"><strong>implementation_type</strong></span></a>
  76                 </p>
  77               </td>
  78 <td>
  79                 <p>
  80                   The implementation type of the deadline timer.
  81                 </p>
  82               </td>
  83 </tr>
  84 <tr>
  85 <td>
  86                 <p>
  87                   <a class="link" href="deadline_timer_service/time_type.html" title="deadline_timer_service::time_type"><span class="bold"><strong>time_type</strong></span></a>
  88                 </p>
  89               </td>
  90 <td>
  91                 <p>
  92                   The time type.
  93                 </p>
  94               </td>
  95 </tr>
  96 <tr>
  97 <td>
  98                 <p>
  99                   <a class="link" href="deadline_timer_service/traits_type.html" title="deadline_timer_service::traits_type"><span class="bold"><strong>traits_type</strong></span></a>
 100                 </p>
 101               </td>
 102 <td>
 103                 <p>
 104                   The time traits type.
 105                 </p>
 106               </td>
 107 </tr>
 108 </tbody>
 109 </table></div>
 110 <h5>
 111 <a name="boost_asio.reference.deadline_timer_service.h1"></a>
 112         <span class="phrase"><a name="boost_asio.reference.deadline_timer_service.member_functions"></a></span><a class="link" href="deadline_timer_service.html#boost_asio.reference.deadline_timer_service.member_functions">Member
 113         Functions</a>
 114       </h5>
 115 <div class="informaltable"><table class="table">
 116 <colgroup>
 117 <col>
 118 <col>
 119 </colgroup>
 120 <thead><tr>
 121 <th>
 122                 <p>
 123                   Name
 124                 </p>
 125               </th>
 126 <th>
 127                 <p>
 128                   Description
 129                 </p>
 130               </th>
 131 </tr></thead>
 132 <tbody>
 133 <tr>
 134 <td>
 135                 <p>
 136                   <a class="link" href="deadline_timer_service/async_wait.html" title="deadline_timer_service::async_wait"><span class="bold"><strong>async_wait</strong></span></a>
 137                 </p>
 138               </td>
 139 <td>
 140               </td>
 141 </tr>
 142 <tr>
 143 <td>
 144                 <p>
 145                   <a class="link" href="deadline_timer_service/cancel.html" title="deadline_timer_service::cancel"><span class="bold"><strong>cancel</strong></span></a>
 146                 </p>
 147               </td>
 148 <td>
 149                 <p>
 150                   Cancel any asynchronous wait operations associated with the timer.
 151                 </p>
 152               </td>
 153 </tr>
 154 <tr>
 155 <td>
 156                 <p>
 157                   <a class="link" href="deadline_timer_service/cancel_one.html" title="deadline_timer_service::cancel_one"><span class="bold"><strong>cancel_one</strong></span></a>
 158                 </p>
 159               </td>
 160 <td>
 161                 <p>
 162                   Cancels one asynchronous wait operation associated with the timer.
 163                 </p>
 164               </td>
 165 </tr>
 166 <tr>
 167 <td>
 168                 <p>
 169                   <a class="link" href="deadline_timer_service/construct.html" title="deadline_timer_service::construct"><span class="bold"><strong>construct</strong></span></a>
 170                 </p>
 171               </td>
 172 <td>
 173                 <p>
 174                   Construct a new timer implementation.
 175                 </p>
 176               </td>
 177 </tr>
 178 <tr>
 179 <td>
 180                 <p>
 181                   <a class="link" href="deadline_timer_service/deadline_timer_service.html" title="deadline_timer_service::deadline_timer_service"><span class="bold"><strong>deadline_timer_service</strong></span></a>
 182                 </p>
 183               </td>
 184 <td>
 185                 <p>
 186                   Construct a new timer service for the specified io_service.
 187                 </p>
 188               </td>
 189 </tr>
 190 <tr>
 191 <td>
 192                 <p>
 193                   <a class="link" href="deadline_timer_service/destroy.html" title="deadline_timer_service::destroy"><span class="bold"><strong>destroy</strong></span></a>
 194                 </p>
 195               </td>
 196 <td>
 197                 <p>
 198                   Destroy a timer implementation.
 199                 </p>
 200               </td>
 201 </tr>
 202 <tr>
 203 <td>
 204                 <p>
 205                   <a class="link" href="deadline_timer_service/expires_at.html" title="deadline_timer_service::expires_at"><span class="bold"><strong>expires_at</strong></span></a>
 206                 </p>
 207               </td>
 208 <td>
 209                 <p>
 210                   Get the expiry time for the timer as an absolute time.
 211                 </p>
 212                 <p>
 213                   Set the expiry time for the timer as an absolute time.
 214                 </p>
 215               </td>
 216 </tr>
 217 <tr>
 218 <td>
 219                 <p>
 220                   <a class="link" href="deadline_timer_service/expires_from_now.html" title="deadline_timer_service::expires_from_now"><span class="bold"><strong>expires_from_now</strong></span></a>
 221                 </p>
 222               </td>
 223 <td>
 224                 <p>
 225                   Get the expiry time for the timer relative to now.
 226                 </p>
 227                 <p>
 228                   Set the expiry time for the timer relative to now.
 229                 </p>
 230               </td>
 231 </tr>
 232 <tr>
 233 <td>
 234                 <p>
 235                   <a class="link" href="deadline_timer_service/get_io_service.html" title="deadline_timer_service::get_io_service"><span class="bold"><strong>get_io_service</strong></span></a>
 236                 </p>
 237               </td>
 238 <td>
 239                 <p>
 240                   Get the io_service object that owns the service.
 241                 </p>
 242               </td>
 243 </tr>
 244 <tr>
 245 <td>
 246                 <p>
 247                   <a class="link" href="deadline_timer_service/wait.html" title="deadline_timer_service::wait"><span class="bold"><strong>wait</strong></span></a>
 248                 </p>
 249               </td>
 250 <td>
 251               </td>
 252 </tr>
 253 </tbody>
 254 </table></div>
 255 <h5>
 256 <a name="boost_asio.reference.deadline_timer_service.h2"></a>
 257         <span class="phrase"><a name="boost_asio.reference.deadline_timer_service.data_members"></a></span><a class="link" href="deadline_timer_service.html#boost_asio.reference.deadline_timer_service.data_members">Data Members</a>
 258       </h5>
 259 <div class="informaltable"><table class="table">
 260 <colgroup>
 261 <col>
 262 <col>
 263 </colgroup>
 264 <thead><tr>
 265 <th>
 266                 <p>
 267                   Name
 268                 </p>
 269               </th>
 270 <th>
 271                 <p>
 272                   Description
 273                 </p>
 274               </th>
 275 </tr></thead>
 276 <tbody><tr>
 277 <td>
 278                 <p>
 279                   <a class="link" href="deadline_timer_service/id.html" title="deadline_timer_service::id"><span class="bold"><strong>id</strong></span></a>
 280                 </p>
 281               </td>
 282 <td>
 283                 <p>
 284                   The unique service identifier.
 285                 </p>
 286               </td>
 287 </tr></tbody>
 288 </table></div>
 289 <h5>
 290 <a name="boost_asio.reference.deadline_timer_service.h3"></a>
 291         <span class="phrase"><a name="boost_asio.reference.deadline_timer_service.requirements"></a></span><a class="link" href="deadline_timer_service.html#boost_asio.reference.deadline_timer_service.requirements">Requirements</a>
 292       </h5>
 293 <p>
 294         <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/deadline_timer_service.hpp</code>
 295       </p>
 296 <p>
 297         <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
 298       </p>
 299 </div>
 300 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 301 <td align="left"></td>
 302 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2017 Christopher M. Kohlhoff<p>
 303         Distributed under the Boost Software License, Version 1.0. (See accompanying
 304         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>)
 305       </p>
 306 </div></td>
 307 </tr></table>
 308 <hr>
 309 <div class="spirit-nav">
 310 <a accesskey="p" href="deadline_timer.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="deadline_timer_service/async_wait.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
 311 </div>
 312 </body>
 313 </html>