Handler.html 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Handlers</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="GettableSocketOption.html" title="Gettable socket option requirements">
  10. <link rel="next" href="HandleService.html" title="Handle 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="GettableSocketOption.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="HandleService.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.Handler"></a><a class="link" href="Handler.html" title="Handlers">Handlers</a>
  21. </h3></div></div></div>
  22. <p>
  23. A handler must meet the requirements of <code class="computeroutput"><span class="identifier">CopyConstructible</span></code>
  24. types (C++ Std, 20.1.3).
  25. </p>
  26. <p>
  27. In the table below, <code class="computeroutput"><span class="identifier">X</span></code> denotes
  28. a handler class, <code class="computeroutput"><span class="identifier">h</span></code> denotes
  29. a value of <code class="computeroutput"><span class="identifier">X</span></code>, <code class="computeroutput"><span class="identifier">p</span></code> denotes a pointer to a block of allocated
  30. memory of type <code class="computeroutput"><span class="keyword">void</span><span class="special">*</span></code>,
  31. <code class="computeroutput"><span class="identifier">s</span></code> denotes the size for a
  32. block of allocated memory, and <code class="computeroutput"><span class="identifier">f</span></code>
  33. denotes a function object taking no arguments.
  34. </p>
  35. <div class="table">
  36. <a name="asio.reference.Handler.t0"></a><p class="title"><b>Table&#160;13.&#160;Handler requirements</b></p>
  37. <div class="table-contents"><table class="table" summary="Handler requirements">
  38. <colgroup>
  39. <col>
  40. <col>
  41. <col>
  42. </colgroup>
  43. <thead><tr>
  44. <th>
  45. <p>
  46. expression
  47. </p>
  48. </th>
  49. <th>
  50. <p>
  51. return type
  52. </p>
  53. </th>
  54. <th>
  55. <p>
  56. assertion/note<br> pre/post-conditions
  57. </p>
  58. </th>
  59. </tr></thead>
  60. <tbody>
  61. <tr>
  62. <td>
  63. <p>
  64. </p>
  65. <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_allocate</span><span class="special">;</span>
  66. <span class="identifier">asio_handler_allocate</span><span class="special">(</span><span class="identifier">s</span><span class="special">,</span> <span class="special">&amp;</span><span class="identifier">h</span><span class="special">);</span>
  67. </pre>
  68. <p>
  69. </p>
  70. </td>
  71. <td>
  72. <p>
  73. <code class="computeroutput"><span class="keyword">void</span><span class="special">*</span></code>
  74. </p>
  75. </td>
  76. <td>
  77. <p>
  78. Returns a pointer to a block of memory of size <code class="computeroutput"><span class="identifier">s</span></code>.
  79. The pointer must satisfy the same alignment requirements as a pointer
  80. returned by <code class="computeroutput"><span class="special">::</span><span class="keyword">operator</span>
  81. <span class="keyword">new</span><span class="special">()</span></code>.
  82. Throws <code class="computeroutput"><span class="identifier">bad_alloc</span></code>
  83. on failure.<br> <br> The <code class="computeroutput"><span class="identifier">asio_handler_allocate</span><span class="special">()</span></code> function is located using argument-dependent
  84. lookup. The function <code class="computeroutput"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_allocate</span><span class="special">()</span></code> serves as a default if no user-supplied
  85. function is available.
  86. </p>
  87. </td>
  88. </tr>
  89. <tr>
  90. <td>
  91. <p>
  92. </p>
  93. <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_deallocate</span><span class="special">;</span>
  94. <span class="identifier">asio_handler_deallocate</span><span class="special">(</span><span class="identifier">p</span><span class="special">,</span> <span class="identifier">s</span><span class="special">,</span> <span class="special">&amp;</span><span class="identifier">h</span><span class="special">);</span>
  95. </pre>
  96. <p>
  97. </p>
  98. </td>
  99. <td>
  100. </td>
  101. <td>
  102. <p>
  103. Frees a block of memory associated with a pointer <code class="computeroutput"><span class="identifier">p</span></code>, of at least size <code class="computeroutput"><span class="identifier">s</span></code>, that was previously allocated
  104. using <code class="computeroutput"><span class="identifier">asio_handler_allocate</span><span class="special">()</span></code>.<br> <br> The <code class="computeroutput"><span class="identifier">asio_handler_deallocate</span><span class="special">()</span></code>
  105. function is located using argument-dependent lookup. The function
  106. <code class="computeroutput"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_deallocate</span><span class="special">()</span></code>
  107. serves as a default if no user-supplied function is available.
  108. </p>
  109. </td>
  110. </tr>
  111. <tr>
  112. <td>
  113. <p>
  114. </p>
  115. <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_invoke</span><span class="special">;</span>
  116. <span class="identifier">asio_handler_invoke</span><span class="special">(</span><span class="identifier">f</span><span class="special">,</span> <span class="special">&amp;</span><span class="identifier">h</span><span class="special">);</span>
  117. </pre>
  118. <p>
  119. </p>
  120. </td>
  121. <td>
  122. </td>
  123. <td>
  124. <p>
  125. Causes the function object <code class="computeroutput"><span class="identifier">f</span></code>
  126. to be executed as if by calling <code class="computeroutput"><span class="identifier">f</span><span class="special">()</span></code>.<br> <br> The <code class="computeroutput"><span class="identifier">asio_handler_invoke</span><span class="special">()</span></code>
  127. function is located using argument-dependent lookup. The function
  128. <code class="computeroutput"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">asio_handler_invoke</span><span class="special">()</span></code>
  129. serves as a default if no user-supplied function is available.
  130. </p>
  131. </td>
  132. </tr>
  133. </tbody>
  134. </table></div>
  135. </div>
  136. <br class="table-break">
  137. </div>
  138. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  139. <td align="left"></td>
  140. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  141. Distributed under the Boost Software License, Version 1.0. (See accompanying
  142. 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>)
  143. </p>
  144. </div></td>
  145. </tr></table>
  146. <hr>
  147. <div class="spirit-nav">
  148. <a accesskey="p" href="GettableSocketOption.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="HandleService.html"><img src="../../next.png" alt="Next"></a>
  149. </div>
  150. </body>
  151. </html>