TimerService.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Timer service requirements</title>
  5. <link rel="stylesheet" href="../../boostbook.css" type="text/css">
  6. <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
  7. <link rel="home" href="../../index.html" title="Asio">
  8. <link rel="up" href="../reference.html" title="Reference">
  9. <link rel="prev" href="TimeTraits.html" title="Time traits requirements">
  10. <link rel="next" href="WaitableTimerService.html" title="Waitable timer service requirements">
  11. </head>
  12. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13. <table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
  14. <hr>
  15. <div class="spirit-nav">
  16. <a accesskey="p" href="TimeTraits.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="WaitableTimerService.html"><img src="../../next.png" alt="Next"></a>
  17. </div>
  18. <div class="section">
  19. <div class="titlepage"><div><div><h3 class="title">
  20. <a name="asio.reference.TimerService"></a><a class="link" href="TimerService.html" title="Timer service requirements">Timer service requirements</a>
  21. </h3></div></div></div>
  22. <p>
  23. A timer service must meet the requirements for an <a class="link" href="IoObjectService.html" title="I/O object service requirements">I/O
  24. object service</a>, as well as the additional requirements listed below.
  25. </p>
  26. <p>
  27. In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
  28. a timer service class for time type <code class="computeroutput"><span class="identifier">Time</span></code>
  29. and traits type <code class="computeroutput"><span class="identifier">TimeTraits</span></code>,
  30. <code class="computeroutput"><span class="identifier">a</span></code> denotes a value of type
  31. <code class="computeroutput"><span class="identifier">X</span></code>, <code class="computeroutput"><span class="identifier">b</span></code>
  32. denotes a value of type <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span></code>,
  33. <code class="computeroutput"><span class="identifier">t</span></code> denotes a value of type
  34. <code class="computeroutput"><span class="identifier">Time</span></code>, <code class="computeroutput"><span class="identifier">d</span></code>
  35. denotes a value of type <code class="computeroutput"><span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">duration_type</span></code>,
  36. <code class="computeroutput"><span class="identifier">e</span></code> denotes a value of type
  37. <code class="computeroutput"><span class="identifier">error_code</span></code>, and <code class="computeroutput"><span class="identifier">h</span></code> denotes a value meeting <a class="link" href="WaitHandler.html" title="Wait handler requirements"><code class="computeroutput"><span class="identifier">WaitHandler</span></code></a> requirements.
  38. </p>
  39. <div class="table">
  40. <a name="asio.reference.TimerService.t0"></a><p class="title"><b>Table&#160;39.&#160;TimerService requirements</b></p>
  41. <div class="table-contents"><table class="table" summary="TimerService requirements">
  42. <colgroup>
  43. <col>
  44. <col>
  45. <col>
  46. </colgroup>
  47. <thead><tr>
  48. <th>
  49. <p>
  50. expression
  51. </p>
  52. </th>
  53. <th>
  54. <p>
  55. return type
  56. </p>
  57. </th>
  58. <th>
  59. <p>
  60. assertion/note<br> pre/post-condition
  61. </p>
  62. </th>
  63. </tr></thead>
  64. <tbody>
  65. <tr>
  66. <td>
  67. <p>
  68. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span></code>
  69. </p>
  70. </td>
  71. <td>
  72. </td>
  73. <td>
  74. <p>
  75. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  76. requirements. Implicitly cancels asynchronous wait operations,
  77. as if by calling <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">cancel</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">e</span><span class="special">)</span></code>.
  78. </p>
  79. </td>
  80. </tr>
  81. <tr>
  82. <td>
  83. <p>
  84. </p>
  85. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">cancel</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">e</span><span class="special">);</span>
  86. </pre>
  87. <p>
  88. </p>
  89. </td>
  90. <td>
  91. <p>
  92. <code class="computeroutput"><span class="identifier">size_t</span></code>
  93. </p>
  94. </td>
  95. <td>
  96. <p>
  97. Causes any outstanding asynchronous wait operations to complete
  98. as soon as possible. Handlers for cancelled operations shall be
  99. passed the error code <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>.
  100. Sets <code class="computeroutput"><span class="identifier">e</span></code> to indicate
  101. success or failure. Returns the number of operations that were
  102. cancelled.
  103. </p>
  104. </td>
  105. </tr>
  106. <tr>
  107. <td>
  108. <p>
  109. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">expires_at</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span></code>
  110. </p>
  111. </td>
  112. <td>
  113. <p>
  114. <code class="computeroutput"><span class="identifier">Time</span></code>
  115. </p>
  116. </td>
  117. <td>
  118. </td>
  119. </tr>
  120. <tr>
  121. <td>
  122. <p>
  123. </p>
  124. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">expires_at</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">t</span><span class="special">,</span> <span class="identifier">e</span><span class="special">);</span>
  125. </pre>
  126. <p>
  127. </p>
  128. </td>
  129. <td>
  130. <p>
  131. <code class="computeroutput"><span class="identifier">size_t</span></code>
  132. </p>
  133. </td>
  134. <td>
  135. <p>
  136. Implicitly cancels asynchronous wait operations, as if by calling
  137. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">cancel</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span>
  138. <span class="identifier">e</span><span class="special">)</span></code>.
  139. Returns the number of operations that were cancelled.<br> post:
  140. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">expires_at</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span>
  141. <span class="special">==</span> <span class="identifier">t</span></code>.
  142. </p>
  143. </td>
  144. </tr>
  145. <tr>
  146. <td>
  147. <p>
  148. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">expires_from_now</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span></code>
  149. </p>
  150. </td>
  151. <td>
  152. <p>
  153. <code class="computeroutput"><span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">duration_type</span></code>
  154. </p>
  155. </td>
  156. <td>
  157. <p>
  158. Returns a value equivalent to <code class="computeroutput"><span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">subtract</span><span class="special">(</span><span class="identifier">a</span><span class="special">.</span><span class="identifier">expires_at</span><span class="special">(</span><span class="identifier">b</span><span class="special">),</span> <span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">now</span><span class="special">())</span></code>.
  159. </p>
  160. </td>
  161. </tr>
  162. <tr>
  163. <td>
  164. <p>
  165. </p>
  166. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">expires_from_now</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">d</span><span class="special">,</span> <span class="identifier">e</span><span class="special">);</span>
  167. </pre>
  168. <p>
  169. </p>
  170. </td>
  171. <td>
  172. <p>
  173. <code class="computeroutput"><span class="identifier">size_t</span></code>
  174. </p>
  175. </td>
  176. <td>
  177. <p>
  178. Equivalent to <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">expires_at</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">add</span><span class="special">(</span><span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">now</span><span class="special">(),</span> <span class="identifier">d</span><span class="special">),</span> <span class="identifier">e</span><span class="special">)</span></code>.
  179. </p>
  180. </td>
  181. </tr>
  182. <tr>
  183. <td>
  184. <p>
  185. </p>
  186. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">wait</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">e</span><span class="special">);</span>
  187. </pre>
  188. <p>
  189. </p>
  190. </td>
  191. <td>
  192. <p>
  193. <code class="computeroutput"><span class="identifier">error_code</span></code>
  194. </p>
  195. </td>
  196. <td>
  197. <p>
  198. Sets <code class="computeroutput"><span class="identifier">e</span></code> to indicate
  199. success or failure. Returns <code class="computeroutput"><span class="identifier">e</span></code>.<br>
  200. post: <code class="computeroutput"><span class="special">!!</span><span class="identifier">e</span>
  201. <span class="special">||</span> <span class="special">!</span><span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">lt</span><span class="special">(</span><span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">now</span><span class="special">(),</span>
  202. <span class="identifier">a</span><span class="special">.</span><span class="identifier">expires_at</span><span class="special">(</span><span class="identifier">b</span><span class="special">))</span></code>.
  203. </p>
  204. </td>
  205. </tr>
  206. <tr>
  207. <td>
  208. <p>
  209. </p>
  210. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">async_wait</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">h</span><span class="special">);</span>
  211. </pre>
  212. <p>
  213. </p>
  214. </td>
  215. <td>
  216. </td>
  217. <td>
  218. <p>
  219. Initiates an asynchronous wait operation that is performed via
  220. the <code class="computeroutput"><span class="identifier">io_service</span></code>
  221. object <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">get_io_service</span><span class="special">()</span></code>
  222. and behaves according to <a class="link" href="asynchronous_operations.html" title="Requirements on asynchronous operations">asynchronous
  223. operation</a> requirements.<br> <br> The handler shall be
  224. posted for execution only if the condition <code class="computeroutput"><span class="special">!!</span><span class="identifier">ec</span> <span class="special">||</span>
  225. <span class="special">!</span><span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">lt</span><span class="special">(</span><span class="identifier">TimeTraits</span><span class="special">::</span><span class="identifier">now</span><span class="special">(),</span> <span class="identifier">a</span><span class="special">.</span><span class="identifier">expires_at</span><span class="special">(</span><span class="identifier">b</span><span class="special">))</span></code> holds, where <code class="computeroutput"><span class="identifier">ec</span></code>
  226. is the error code to be passed to the handler.
  227. </p>
  228. </td>
  229. </tr>
  230. </tbody>
  231. </table></div>
  232. </div>
  233. <br class="table-break">
  234. </div>
  235. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  236. <td align="left"></td>
  237. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  238. Distributed under the Boost Software License, Version 1.0. (See accompanying
  239. 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>)
  240. </p>
  241. </div></td>
  242. </tr></table>
  243. <hr>
  244. <div class="spirit-nav">
  245. <a accesskey="p" href="TimeTraits.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="WaitableTimerService.html"><img src="../../next.png" alt="Next"></a>
  246. </div>
  247. </body>
  248. </html>