BufferedHandshakeHandler.html 7.2 KB

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