1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::accept (6 of 6 overloads)</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 1. Boost.Beast"> 8<link rel="up" href="../accept.html" title="websocket::stream::accept"> 9<link rel="prev" href="overload5.html" title="websocket::stream::accept (5 of 6 overloads)"> 10<link rel="next" href="../async_accept.html" title="websocket::stream::async_accept"> 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="overload5.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accept.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_accept.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h6 class="title"> 27<a name="beast.ref.boost__beast__websocket__stream.accept.overload6"></a><a class="link" href="overload6.html" title="websocket::stream::accept (6 of 6 overloads)">websocket::stream::accept 28 (6 of 6 overloads)</a> 29</h6></div></div></div> 30<p> 31 Respond to a WebSocket HTTP Upgrade request. 32 </p> 33<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload6.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload6.synopsis"></a></span><a class="link" href="overload6.html#beast.ref.boost__beast__websocket__stream.accept.overload6.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">template</span><span class="special"><</span> 36 <span class="keyword">class</span> <a class="link" href="../../../concepts/Body.html" title="Body"><span class="emphasis"><em>Body</em></span></a><span class="special">,</span> 37 <span class="keyword">class</span> <a href="https://en.cppreference.com/w/cpp/named_req/Allocator" target="_top"><span class="emphasis"><em>Allocator</em></span></a><span class="special">></span> 38<span class="keyword">void</span> 39<span class="identifier">accept</span><span class="special">(</span> 40 <span class="identifier">http</span><span class="special">::</span><span class="identifier">request</span><span class="special"><</span> <span class="identifier">Body</span><span class="special">,</span> <span class="identifier">http</span><span class="special">::</span><span class="identifier">basic_fields</span><span class="special"><</span> <span class="identifier">Allocator</span> <span class="special">>></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">req</span><span class="special">,</span> 41 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> 42</pre> 43<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload6.h1"></a> 44 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload6.description"></a></span><a class="link" href="overload6.html#beast.ref.boost__beast__websocket__stream.accept.overload6.description">Description</a> 45 </h7><p> 46 This function is used to perform the <a href="https://en.wikipedia.org/wiki/WebSocket#Protocol_handshake" target="_top">WebSocket 47 handshake</a>, required before messages can be sent and received. 48 During the handshake, the client sends the Websocket Upgrade HTTP request, 49 and the server replies with an HTTP response indicating the result of 50 the handshake. The call blocks until one of the following conditions 51 is true: 52 </p> 53<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 54<li class="listitem"> 55 The response is sent. 56 </li> 57<li class="listitem"> 58 An error occurs. 59 </li> 60</ul></div> 61<p> 62 The algorithm, known as a <span class="emphasis"><em>composed operation</em></span>, is 63 implemented in terms of calls to the next layer's <code class="computeroutput"><span class="identifier">read_some</span></code> 64 and <code class="computeroutput"><span class="identifier">write_some</span></code> functions. 65 If a valid upgrade request is received, an HTTP response with a <a href="https://tools.ietf.org/html/rfc7230#section-3.1.2" target="_top">status-code</a> 66 of <a class="link" href="../../boost__beast__http__status.html" title="http::status"><code class="computeroutput"><span class="identifier">beast</span><span class="special">::</span><span class="identifier">http</span><span class="special">::</span><span class="identifier">status</span><span class="special">::</span><span class="identifier">switching_protocols</span></code></a> is sent 67 to the peer, otherwise a non-successful error is associated with the 68 operation. 69 </p> 70<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload6.h2"></a> 71 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload6.parameters"></a></span><a class="link" href="overload6.html#beast.ref.boost__beast__websocket__stream.accept.overload6.parameters">Parameters</a> 72 </h7><div class="informaltable"><table class="table"> 73<colgroup> 74<col> 75<col> 76</colgroup> 77<thead><tr> 78<th> 79 <p> 80 Name 81 </p> 82 </th> 83<th> 84 <p> 85 Description 86 </p> 87 </th> 88</tr></thead> 89<tbody> 90<tr> 91<td> 92 <p> 93 <code class="computeroutput"><span class="identifier">req</span></code> 94 </p> 95 </td> 96<td> 97 <p> 98 An object containing the HTTP Upgrade request. Ownership is 99 not transferred, the implementation will not access this object 100 from other threads. 101 </p> 102 </td> 103</tr> 104<tr> 105<td> 106 <p> 107 <code class="computeroutput"><span class="identifier">ec</span></code> 108 </p> 109 </td> 110<td> 111 <p> 112 Set to indicate what error occurred, if any. 113 </p> 114 </td> 115</tr> 116</tbody> 117</table></div> 118<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload6.h3"></a> 119 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload6.see_also"></a></span><a class="link" href="overload6.html#beast.ref.boost__beast__websocket__stream.accept.overload6.see_also">See 120 Also</a> 121 </h7><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 122 <a href="https://tools.ietf.org/html/rfc6455#section-4.2" target="_top">Websocket 123 Opening Handshake Server Requirements (RFC6455)</a> 124 </li></ul></div> 125</div> 126<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 127<td align="left"></td> 128<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 129 Falco<p> 130 Distributed under the Boost Software License, Version 1.0. (See accompanying 131 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>) 132 </p> 133</div></td> 134</tr></table> 135<hr> 136<div class="spirit-nav"> 137<a accesskey="p" href="overload5.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../accept.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_accept.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 138</div> 139</body> 140</html> 141
