WaitableTimerService.html 15 KB

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