CompletionHandler.html 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Completion handler 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="BufferedHandshakeHandler.html" title="Buffered handshake handler requirements">
  10. <link rel="next" href="ComposedConnectHandler.html" title="Composed connect 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="BufferedHandshakeHandler.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="ComposedConnectHandler.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.CompletionHandler"></a><a class="link" href="CompletionHandler.html" title="Completion handler requirements">Completion handler
  21. requirements</a>
  22. </h3></div></div></div>
  23. <p>
  24. A completion handler must meet the requirements for a <a class="link" href="Handler.html" title="Handlers">handler</a>.
  25. A value <code class="computeroutput"><span class="identifier">h</span></code> of a completion
  26. handler class should work correctly in the expression <code class="computeroutput"><span class="identifier">h</span><span class="special">()</span></code>.
  27. </p>
  28. <h5>
  29. <a name="asio.reference.CompletionHandler.h0"></a>
  30. <span><a name="asio.reference.CompletionHandler.examples"></a></span><a class="link" href="CompletionHandler.html#asio.reference.CompletionHandler.examples">Examples</a>
  31. </h5>
  32. <p>
  33. A free function as a completion handler:
  34. </p>
  35. <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">completion_handler</span><span class="special">()</span>
  36. <span class="special">{</span>
  37. <span class="special">...</span>
  38. <span class="special">}</span>
  39. </pre>
  40. <p>
  41. A completion handler function object:
  42. </p>
  43. <pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">completion_handler</span>
  44. <span class="special">{</span>
  45. <span class="special">...</span>
  46. <span class="keyword">void</span> <span class="keyword">operator</span><span class="special">()()</span>
  47. <span class="special">{</span>
  48. <span class="special">...</span>
  49. <span class="special">}</span>
  50. <span class="special">...</span>
  51. <span class="special">};</span>
  52. </pre>
  53. <p>
  54. A non-static class member function adapted to a completion handler using
  55. <code class="computeroutput"><span class="identifier">bind</span><span class="special">()</span></code>:
  56. </p>
  57. <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">my_class</span><span class="special">::</span><span class="identifier">completion_handler</span><span class="special">()</span>
  58. <span class="special">{</span>
  59. <span class="special">...</span>
  60. <span class="special">}</span>
  61. <span class="special">...</span>
  62. <span class="identifier">my_io_service</span><span class="special">.</span><span class="identifier">post</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">bind</span><span class="special">(&amp;</span><span class="identifier">my_class</span><span class="special">::</span><span class="identifier">completion_handler</span><span class="special">,</span> <span class="keyword">this</span><span class="special">));</span>
  63. </pre>
  64. </div>
  65. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  66. <td align="left"></td>
  67. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  68. Distributed under the Boost Software License, Version 1.0. (See accompanying
  69. 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>)
  70. </p>
  71. </div></td>
  72. </tr></table>
  73. <hr>
  74. <div class="spirit-nav">
  75. <a accesskey="p" href="BufferedHandshakeHandler.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="ComposedConnectHandler.html"><img src="../../next.png" alt="Next"></a>
  76. </div>
  77. </body>
  78. </html>