HandleService.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Handle 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="Handler.html" title="Handlers">
  10. <link rel="next" href="HandshakeHandler.html" title="SSL handshake 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="Handler.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="HandshakeHandler.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.HandleService"></a><a class="link" href="HandleService.html" title="Handle service requirements">Handle service requirements</a>
  21. </h3></div></div></div>
  22. <p>
  23. A handle 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> with support for movability, as well as the additional
  25. requirements listed below.
  26. </p>
  27. <p>
  28. In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
  29. a handle service class, <code class="computeroutput"><span class="identifier">a</span></code>
  30. and <code class="computeroutput"><span class="identifier">ao</span></code> denote values of type
  31. <code class="computeroutput"><span class="identifier">X</span></code>, <code class="computeroutput"><span class="identifier">b</span></code>
  32. and <code class="computeroutput"><span class="identifier">c</span></code> denote values of type
  33. <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">n</span></code>
  34. denotes a value of type <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">native_handle_type</span></code>,
  35. <code class="computeroutput"><span class="identifier">ec</span></code> denotes a value of type
  36. <code class="computeroutput"><span class="identifier">error_code</span></code>, and <code class="computeroutput"><span class="identifier">u</span></code> and <code class="computeroutput"><span class="identifier">v</span></code>
  37. denote identifiers.
  38. </p>
  39. <div class="table">
  40. <a name="asio.reference.HandleService.t0"></a><p class="title"><b>Table&#160;14.&#160;HandleService requirements</b></p>
  41. <div class="table-contents"><table class="table" summary="HandleService 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">X</span><span class="special">::</span><span class="identifier">native_handle_type</span></code>
  69. </p>
  70. </td>
  71. <td>
  72. </td>
  73. <td>
  74. <p>
  75. The implementation-defined native representation of a handle. Must
  76. satisfy the requirements of <code class="computeroutput"><span class="identifier">CopyConstructible</span></code>
  77. types (C++ Std, 20.1.3), and the requirements of <code class="computeroutput"><span class="identifier">Assignable</span></code> types (C++ Std, 23.1).
  78. </p>
  79. </td>
  80. </tr>
  81. <tr>
  82. <td>
  83. <p>
  84. <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>
  85. </p>
  86. </td>
  87. <td>
  88. </td>
  89. <td>
  90. <p>
  91. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  92. requirements.<br> post: <code class="computeroutput"><span class="special">!</span><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>.
  93. </p>
  94. </td>
  95. </tr>
  96. <tr>
  97. <td>
  98. <p>
  99. <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>
  100. </p>
  101. </td>
  102. <td>
  103. </td>
  104. <td>
  105. <p>
  106. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  107. requirements. Implicitly cancels asynchronous operations, as if
  108. by calling <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span>
  109. <span class="identifier">ec</span><span class="special">)</span></code>.
  110. </p>
  111. </td>
  112. </tr>
  113. <tr>
  114. <td>
  115. <p>
  116. </p>
  117. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">move_construct</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">c</span><span class="special">);</span>
  118. </pre>
  119. <p>
  120. </p>
  121. </td>
  122. <td>
  123. </td>
  124. <td>
  125. <p>
  126. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  127. requirements. The underlying native representation is moved from
  128. <code class="computeroutput"><span class="identifier">c</span></code> to <code class="computeroutput"><span class="identifier">b</span></code>.
  129. </p>
  130. </td>
  131. </tr>
  132. <tr>
  133. <td>
  134. <p>
  135. </p>
  136. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">move_assign</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ao</span><span class="special">,</span> <span class="identifier">c</span><span class="special">);</span>
  137. </pre>
  138. <p>
  139. </p>
  140. </td>
  141. <td>
  142. </td>
  143. <td>
  144. <p>
  145. From <a class="link" href="IoObjectService.html" title="I/O object service requirements">IoObjectService</a>
  146. requirements. Implicitly cancels asynchronous operations associated
  147. with <code class="computeroutput"><span class="identifier">b</span></code>, as if by
  148. calling <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">close</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span>
  149. <span class="identifier">ec</span><span class="special">)</span></code>.
  150. Then the underlying native representation is moved from <code class="computeroutput"><span class="identifier">c</span></code> to <code class="computeroutput"><span class="identifier">b</span></code>.
  151. </p>
  152. </td>
  153. </tr>
  154. <tr>
  155. <td>
  156. <p>
  157. </p>
  158. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">assign</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>
  159. </pre>
  160. <p>
  161. </p>
  162. </td>
  163. <td>
  164. <p>
  165. <code class="computeroutput"><span class="identifier">error_code</span></code>
  166. </p>
  167. </td>
  168. <td>
  169. <p>
  170. pre: <code class="computeroutput"><span class="special">!</span><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> post: <code class="computeroutput"><span class="special">!!</span><span class="identifier">ec</span> <span class="special">||</span>
  171. <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>.
  172. </p>
  173. </td>
  174. </tr>
  175. <tr>
  176. <td>
  177. <p>
  178. </p>
  179. <pre class="programlisting"><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>
  180. </pre>
  181. <p>
  182. </p>
  183. </td>
  184. <td>
  185. <p>
  186. <code class="computeroutput"><span class="keyword">bool</span></code>
  187. </p>
  188. </td>
  189. <td>
  190. </td>
  191. </tr>
  192. <tr>
  193. <td>
  194. <p>
  195. </p>
  196. <pre class="programlisting"><span class="keyword">const</span> <span class="identifier">X</span><span class="special">&amp;</span> <span class="identifier">u</span> <span class="special">=</span> <span class="identifier">a</span><span class="special">;</span>
  197. <span class="keyword">const</span> <span class="identifier">X</span><span class="special">::</span><span class="identifier">implementation_type</span><span class="special">&amp;</span> <span class="identifier">v</span> <span class="special">=</span> <span class="identifier">b</span><span class="special">;</span>
  198. <span class="identifier">u</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">(</span><span class="identifier">v</span><span class="special">);</span>
  199. </pre>
  200. <p>
  201. </p>
  202. </td>
  203. <td>
  204. <p>
  205. <code class="computeroutput"><span class="keyword">bool</span></code>
  206. </p>
  207. </td>
  208. <td>
  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">close</span><span class="special">(</span><span class="identifier">b</span><span class="special">,</span> <span class="identifier">ec</span><span class="special">);</span>
  216. </pre>
  217. <p>
  218. </p>
  219. </td>
  220. <td>
  221. <p>
  222. <code class="computeroutput"><span class="identifier">error_code</span></code>
  223. </p>
  224. </td>
  225. <td>
  226. <p>
  227. If <code class="computeroutput"><span class="identifier">a</span><span class="special">.</span><span class="identifier">is_open</span><span class="special">()</span></code>
  228. is true, causes any outstanding asynchronous operations to complete
  229. as soon as possible. Handlers for cancelled operations shall be
  230. passed the error code <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>.<br>
  231. post: <code class="computeroutput"><span class="special">!</span><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>.
  232. </p>
  233. </td>
  234. </tr>
  235. <tr>
  236. <td>
  237. <p>
  238. </p>
  239. <pre class="programlisting"><span class="identifier">a</span><span class="special">.</span><span class="identifier">native_handle</span><span class="special">(</span><span class="identifier">b</span><span class="special">);</span>
  240. </pre>
  241. <p>
  242. </p>
  243. </td>
  244. <td>
  245. <p>
  246. <code class="computeroutput"><span class="identifier">X</span><span class="special">::</span><span class="identifier">native_handle_type</span></code>
  247. </p>
  248. </td>
  249. <td>
  250. </td>
  251. </tr>
  252. <tr>
  253. <td>
  254. <p>
  255. </p>
  256. <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>
  257. </pre>
  258. <p>
  259. </p>
  260. </td>
  261. <td>
  262. <p>
  263. <code class="computeroutput"><span class="identifier">error_code</span></code>
  264. </p>
  265. </td>
  266. <td>
  267. <p>
  268. 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>
  269. Causes any outstanding asynchronous operations to complete as soon
  270. as possible. Handlers for cancelled operations shall be passed
  271. the error code <code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>.
  272. </p>
  273. </td>
  274. </tr>
  275. </tbody>
  276. </table></div>
  277. </div>
  278. <br class="table-break">
  279. </div>
  280. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  281. <td align="left"></td>
  282. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  283. Distributed under the Boost Software License, Version 1.0. (See accompanying
  284. 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>)
  285. </p>
  286. </div></td>
  287. </tr></table>
  288. <hr>
  289. <div class="spirit-nav">
  290. <a accesskey="p" href="Handler.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="HandshakeHandler.html"><img src="../../next.png" alt="Next"></a>
  291. </div>
  292. </body>
  293. </html>