ObjectHandleService.html 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Object 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="MutableBufferSequence.html" title="Mutable buffer sequence requirements">
  10. <link rel="next" href="Protocol.html" title="Protocol 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="MutableBufferSequence.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="Protocol.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.ObjectHandleService"></a><a class="link" href="ObjectHandleService.html" title="Object handle service requirements">Object handle service
  21. requirements</a>
  22. </h3></div></div></div>
  23. <p>
  24. An object handle service must meet the requirements for a <a class="link" href="HandleService.html" title="Handle service requirements">handle
  25. 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. an object handle service class, <code class="computeroutput"><span class="identifier">a</span></code>
  30. denotes a value of type <code class="computeroutput"><span class="identifier">X</span></code>,
  31. <code class="computeroutput"><span class="identifier">b</span></code> denotes a value of type
  32. <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>
  33. denotes a value of type <code class="computeroutput"><span class="identifier">error_code</span></code>,
  34. and <code class="computeroutput"><span class="identifier">wh</span></code> denotes a value meeting
  35. <a class="link" href="WaitHandler.html" title="Wait handler requirements"><code class="computeroutput"><span class="identifier">WaitHandler</span></code></a>
  36. requirements.
  37. </p>
  38. <div class="table">
  39. <a name="asio.reference.ObjectHandleService.t0"></a><p class="title"><b>Table&#160;19.&#160;ObjectHandleService requirements</b></p>
  40. <div class="table-contents"><table class="table" summary="ObjectHandleService requirements">
  41. <colgroup>
  42. <col>
  43. <col>
  44. <col>
  45. </colgroup>
  46. <thead><tr>
  47. <th>
  48. <p>
  49. expression
  50. </p>
  51. </th>
  52. <th>
  53. <p>
  54. return type
  55. </p>
  56. </th>
  57. <th>
  58. <p>
  59. assertion/note<br> pre/post-condition
  60. </p>
  61. </th>
  62. </tr></thead>
  63. <tbody>
  64. <tr>
  65. <td>
  66. <p>
  67. <code class="computeroutput"><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>
  68. <span class="identifier">ec</span><span class="special">);</span></code>
  69. </p>
  70. </td>
  71. <td>
  72. <p>
  73. <code class="computeroutput"><span class="identifier">error_code</span></code>
  74. </p>
  75. </td>
  76. <td>
  77. <p>
  78. 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>
  79. <br> Synchronously waits for the object represented by handle
  80. <code class="computeroutput"><span class="identifier">b</span></code> to become signalled.
  81. </p>
  82. </td>
  83. </tr>
  84. <tr>
  85. <td>
  86. <p>
  87. <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>
  88. <span class="identifier">wh</span><span class="special">);</span></code>
  89. </p>
  90. </td>
  91. <td>
  92. <p>
  93. <code class="computeroutput"><span class="keyword">void</span></code>
  94. </p>
  95. </td>
  96. <td>
  97. <p>
  98. 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>
  99. <br> Initiates an asynchronous operation to wait for the object
  100. represented by handle <code class="computeroutput"><span class="identifier">b</span></code>
  101. to become signalled. The operation is performed via the <code class="computeroutput"><span class="identifier">io_service</span></code> 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>
  102. and behaves according to <a class="link" href="asynchronous_operations.html" title="Requirements on asynchronous operations">asynchronous
  103. operation</a> requirements.
  104. </p>
  105. </td>
  106. </tr>
  107. </tbody>
  108. </table></div>
  109. </div>
  110. <br class="table-break">
  111. </div>
  112. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  113. <td align="left"></td>
  114. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  115. Distributed under the Boost Software License, Version 1.0. (See accompanying
  116. 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>)
  117. </p>
  118. </div></td>
  119. </tr></table>
  120. <hr>
  121. <div class="spirit-nav">
  122. <a accesskey="p" href="MutableBufferSequence.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="Protocol.html"><img src="../../next.png" alt="Next"></a>
  123. </div>
  124. </body>
  125. </html>