SignalSetService.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Signal set 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="SignalHandler.html" title="Signal handler requirements">
  10. <link rel="next" href="SocketAcceptorService.html" title="Socket acceptor 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="SignalHandler.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="SocketAcceptorService.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.SignalSetService"></a><a class="link" href="SignalSetService.html" title="Signal set service requirements">Signal set service requirements</a>
  21. </h3></div></div></div>
  22. <p>
  23. A signal set 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 signal set service class, <code class="computeroutput"><span class="identifier">a</span></code>
  29. denotes a value of type <code class="computeroutput"><span class="identifier">X</span></code>,
  30. <code class="computeroutput"><span class="identifier">b</span></code> denotes a value of type
  31. <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">ec</span></code>
  32. denotes a value of type <code class="computeroutput"><span class="identifier">error_code</span></code>,
  33. <code class="computeroutput"><span class="identifier">n</span></code> denotes a value of type
  34. <code class="computeroutput"><span class="keyword">int</span></code>, and <code class="computeroutput"><span class="identifier">sh</span></code>
  35. denotes a value meeting <a class="link" href="SignalHandler.html" title="Signal handler requirements"><code class="computeroutput"><span class="identifier">SignalHandler</span></code></a> requirements.
  36. </p>
  37. <div class="table">
  38. <a name="asio.reference.SignalSetService.t0"></a><p class="title"><b>Table&#160;28.&#160;SignalSetService requirements</b></p>
  39. <div class="table-contents"><table class="table" summary="SignalSetService requirements">
  40. <colgroup>
  41. <col>
  42. <col>
  43. <col>
  44. </colgroup>
  45. <thead><tr>
  46. <th>
  47. <p>
  48. expression
  49. </p>
  50. </th>
  51. <th>
  52. <p>
  53. return type
  54. </p>
  55. </th>
  56. <th>
  57. <p>
  58. assertion/note<br> pre/post-condition
  59. </p>
  60. </th>
  61. </tr></thead>
  62. <tbody>
  63. <tr>
  64. <td>
  65. <p>
  66. <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">construct</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span></code>
  67. </p>
  68. </td>
  69. <td>
  70. </td>
  71. <td>
  72. <p>
  73. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  74. requirements.<br>
  75. </p>
  76. </td>
  77. </tr>
  78. <tr>
  79. <td>
  80. <p>
  81. <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>
  82. </p>
  83. </td>
  84. <td>
  85. </td>
  86. <td>
  87. <p>
  88. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  89. requirements. Implicitly clears the registered signals as if by
  90. calling <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">clear</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span>
  91. <span class="identifier">ec</span><span class="special">)</span></code>,
  92. then implicitly cancels outstanding asynchronous operations as
  93. 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">ec</span><span class="special">)</span></code>.
  94. </p>
  95. </td>
  96. </tr>
  97. <tr>
  98. <td>
  99. <p>
  100. </p>
  101. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">add</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">n</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  102. </pre>
  103. <p>
  104. </p>
  105. </td>
  106. <td>
  107. <p>
  108. <code class="computeroutput"><span class="identifier">error_code</span></code>
  109. </p>
  110. </td>
  111. <td>
  112. </td>
  113. </tr>
  114. <tr>
  115. <td>
  116. <p>
  117. </p>
  118. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">remove</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">n</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  119. </pre>
  120. <p>
  121. </p>
  122. </td>
  123. <td>
  124. <p>
  125. <code class="computeroutput"><span class="identifier">error_code</span></code>
  126. </p>
  127. </td>
  128. <td>
  129. </td>
  130. </tr>
  131. <tr>
  132. <td>
  133. <p>
  134. </p>
  135. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">clear</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  136. </pre>
  137. <p>
  138. </p>
  139. </td>
  140. <td>
  141. <p>
  142. <code class="computeroutput"><span class="identifier">error_code</span></code>
  143. </p>
  144. </td>
  145. <td>
  146. </td>
  147. </tr>
  148. <tr>
  149. <td>
  150. <p>
  151. </p>
  152. <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">ec</span><span class="special">);</span>
  153. </pre>
  154. <p>
  155. </p>
  156. </td>
  157. <td>
  158. <p>
  159. <code class="computeroutput"><span class="identifier">error_code</span></code>
  160. </p>
  161. </td>
  162. <td>
  163. </td>
  164. </tr>
  165. <tr>
  166. <td>
  167. <p>
  168. <code class="computeroutput"><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>
  169. <span class="identifier">sh</span><span class="special">);</span></code>
  170. </p>
  171. </td>
  172. <td>
  173. <p>
  174. <code class="computeroutput"><span class="keyword">void</span></code>
  175. </p>
  176. </td>
  177. <td>
  178. <p>
  179. pre: <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">b</span><span class="special">)</span></code>.<br>
  180. <br> Initiates an asynchronous operation to wait for the delivery
  181. of one of the signals registered for the signal set <code class="computeroutput"><span class="identifier">b</span></code>. The operation is performed
  182. via the <code class="computeroutput"><span class="identifier">io_service</span></code>
  183. 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>
  184. and behaves according to <a class="link" href="asynchronous_operations.html" title="Requirements on asynchronous operations">asynchronous
  185. operation</a> requirements.<br> <br> If the operation completes
  186. successfully, the <code class="computeroutput"><span class="identifier">SignalHandler</span></code>
  187. object <code class="computeroutput"><span class="identifier">sh</span></code> is invoked
  188. with the number identifying the delivered signal. Otherwise it
  189. is invoked with <code class="computeroutput"><span class="number">0</span></code>.
  190. </p>
  191. </td>
  192. </tr>
  193. </tbody>
  194. </table></div>
  195. </div>
  196. <br class="table-break">
  197. </div>
  198. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  199. <td align="left"></td>
  200. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  201. Distributed under the Boost Software License, Version 1.0. (See accompanying
  202. 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>)
  203. </p>
  204. </div></td>
  205. </tr></table>
  206. <hr>
  207. <div class="spirit-nav">
  208. <a accesskey="p" href="SignalHandler.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="SocketAcceptorService.html"><img src="../../next.png" alt="Next"></a>
  209. </div>
  210. </body>
  211. </html>