libs/beast/doc/html/beast/ref/boost__beast__websocket__stream/async_handshake.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>websocket::stream::async_handshake</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../boost__beast__websocket__stream.html" title="websocket::stream">
   9 <link rel="prev" href="async_close.html" title="websocket::stream::async_close">
  10 <link rel="next" href="async_handshake/overload1.html" title="websocket::stream::async_handshake (1 of 2 overloads)">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="async_close.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__websocket__stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_handshake/overload1.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="beast.ref.boost__beast__websocket__stream.async_handshake"></a><a class="link" href="async_handshake.html" title="websocket::stream::async_handshake">websocket::stream::async_handshake</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873473209152"></a>
  31 Perform the WebSocket handshake asynchronously
  32           in the client role.
  33         </p>
  34 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  35     <span class="keyword">class</span> <span class="identifier">HandshakeHandler</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span><span class="identifier">executor_type</span><span class="special">&gt;&gt;</span>
  36 <a href="../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a>
  37 <a class="link" href="async_handshake/overload1.html" title="websocket::stream::async_handshake (1 of 2 overloads)">async_handshake</a><span class="special">(</span>
  38     <span class="identifier">string_view</span> <span class="identifier">host</span><span class="special">,</span>
  39     <span class="identifier">string_view</span> <span class="identifier">target</span><span class="special">,</span>
  40     <span class="identifier">HandshakeHandler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span> <span class="identifier">executor_type</span> <span class="special">&gt;{});</span>
  41   <span class="emphasis"><em>&#187; <a class="link" href="async_handshake/overload1.html" title="websocket::stream::async_handshake (1 of 2 overloads)">more...</a></em></span>
  42
  43 <span class="keyword">template</span><span class="special">&lt;</span>
  44     <span class="keyword">class</span> <span class="identifier">HandshakeHandler</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span><span class="identifier">executor_type</span><span class="special">&gt;&gt;</span>
  45 <a href="../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a>
  46 <a class="link" href="async_handshake/overload2.html" title="websocket::stream::async_handshake (2 of 2 overloads)">async_handshake</a><span class="special">(</span>
  47     <span class="identifier">response_type</span><span class="special">&amp;</span> <span class="identifier">res</span><span class="special">,</span>
  48     <span class="identifier">string_view</span> <span class="identifier">host</span><span class="special">,</span>
  49     <span class="identifier">string_view</span> <span class="identifier">target</span><span class="special">,</span>
  50     <span class="identifier">HandshakeHandler</span><span class="special">&amp;&amp;</span> <span class="identifier">handler</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special">&lt;</span> <span class="identifier">executor_type</span> <span class="special">&gt;{});</span>
  51   <span class="emphasis"><em>&#187; <a class="link" href="async_handshake/overload2.html" title="websocket::stream::async_handshake (2 of 2 overloads)">more...</a></em></span>
  52 </pre>
  53 </div>
  54 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  55 <td align="left"></td>
  56 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  57       Falco<p>
  58         Distributed under the Boost Software License, Version 1.0. (See accompanying
  59         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>)
  60       </p>
  61 </div></td>
  62 </tr></table>
  63 <hr>
  64 <div class="spirit-nav">
  65 <a accesskey="p" href="async_close.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__websocket__stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="async_handshake/overload1.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  66 </div>
  67 </body>
  68 </html>