ReadHandler.html 6.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. <html>
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
  4. <title>Read 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="RawSocketService.html" title="Raw socket service requirements">
  10. <link rel="next" href="ResolveHandler.html" title="Resolve 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="RawSocketService.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="ResolveHandler.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.ReadHandler"></a><a class="link" href="ReadHandler.html" title="Read handler requirements">Read handler requirements</a>
  21. </h3></div></div></div>
  22. <p>
  23. A read handler must meet the requirements for a <a class="link" href="Handler.html" title="Handlers">handler</a>.
  24. A value <code class="computeroutput"><span class="identifier">h</span></code> of a read handler
  25. class should work correctly in the expression <code class="computeroutput"><span class="identifier">h</span><span class="special">(</span><span class="identifier">ec</span><span class="special">,</span>
  26. <span class="identifier">s</span><span class="special">)</span></code>,
  27. where <code class="computeroutput"><span class="identifier">ec</span></code> is an lvalue of
  28. type <code class="computeroutput"><span class="keyword">const</span> <span class="identifier">error_code</span></code>
  29. and <code class="computeroutput"><span class="identifier">s</span></code> is an lvalue of type
  30. <code class="computeroutput"><span class="keyword">const</span> <span class="identifier">size_t</span></code>.
  31. </p>
  32. <h5>
  33. <a name="asio.reference.ReadHandler.h0"></a>
  34. <span><a name="asio.reference.ReadHandler.examples"></a></span><a class="link" href="ReadHandler.html#asio.reference.ReadHandler.examples">Examples</a>
  35. </h5>
  36. <p>
  37. A free function as a read handler:
  38. </p>
  39. <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">read_handler</span><span class="special">(</span>
  40. <span class="keyword">const</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
  41. <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span><span class="special">)</span>
  42. <span class="special">{</span>
  43. <span class="special">...</span>
  44. <span class="special">}</span>
  45. </pre>
  46. <p>
  47. A read handler function object:
  48. </p>
  49. <pre class="programlisting"><span class="keyword">struct</span> <span class="identifier">read_handler</span>
  50. <span class="special">{</span>
  51. <span class="special">...</span>
  52. <span class="keyword">void</span> <span class="keyword">operator</span><span class="special">()(</span>
  53. <span class="keyword">const</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
  54. <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span><span class="special">)</span>
  55. <span class="special">{</span>
  56. <span class="special">...</span>
  57. <span class="special">}</span>
  58. <span class="special">...</span>
  59. <span class="special">};</span>
  60. </pre>
  61. <p>
  62. A non-static class member function adapted to a read handler using <code class="computeroutput"><span class="identifier">bind</span><span class="special">()</span></code>:
  63. </p>
  64. <pre class="programlisting"><span class="keyword">void</span> <span class="identifier">my_class</span><span class="special">::</span><span class="identifier">read_handler</span><span class="special">(</span>
  65. <span class="keyword">const</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">ec</span><span class="special">,</span>
  66. <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span><span class="special">)</span>
  67. <span class="special">{</span>
  68. <span class="special">...</span>
  69. <span class="special">}</span>
  70. <span class="special">...</span>
  71. <span class="identifier">socket</span><span class="special">.</span><span class="identifier">async_read</span><span class="special">(...,</span>
  72. <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">read_handler</span><span class="special">,</span>
  73. <span class="keyword">this</span><span class="special">,</span> <span class="identifier">asio</span><span class="special">::</span><span class="identifier">placeholders</span><span class="special">::</span><span class="identifier">error</span><span class="special">,</span>
  74. <span class="identifier">asio</span><span class="special">::</span><span class="identifier">placeholders</span><span class="special">::</span><span class="identifier">bytes_transferred</span><span class="special">));</span>
  75. </pre>
  76. </div>
  77. <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  78. <td align="left"></td>
  79. <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2014 Christopher M. Kohlhoff<p>
  80. Distributed under the Boost Software License, Version 1.0. (See accompanying
  81. 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>)
  82. </p>
  83. </div></td>
  84. </tr></table>
  85. <hr>
  86. <div class="spirit-nav">
  87. <a accesskey="p" href="RawSocketService.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="ResolveHandler.html"><img src="../../next.png" alt="Next"></a>
  88. </div>
  89. </body>
  90. </html>