1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::accept (5 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="overload4.html" title="websocket::stream::accept (4 of 6 overloads)"> 10<link rel="next" href="overload6.html" title="websocket::stream::accept (6 of 6 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="overload4.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="overload6.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.overload5"></a><a class="link" href="overload5.html" title="websocket::stream::accept (5 of 6 overloads)">websocket::stream::accept 28 (5 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.overload5.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.synopsis"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__websocket__stream.accept.overload5.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</pre> 42<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.h1"></a> 43 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.description"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__websocket__stream.accept.overload5.description">Description</a> 44 </h7><p> 45 This function is used to perform the <a href="https://en.wikipedia.org/wiki/WebSocket#Protocol_handshake" target="_top">WebSocket 46 handshake</a>, required before messages can be sent and received. 47 During the handshake, the client sends the Websocket Upgrade HTTP request, 48 and the server replies with an HTTP response indicating the result of 49 the handshake. The call blocks until one of the following conditions 50 is true: 51 </p> 52<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 53<li class="listitem"> 54 The response is sent. 55 </li> 56<li class="listitem"> 57 An error occurs. 58 </li> 59</ul></div> 60<p> 61 The algorithm, known as a <span class="emphasis"><em>composed operation</em></span>, is 62 implemented in terms of calls to the next layer's <code class="computeroutput"><span class="identifier">read_some</span></code> 63 and <code class="computeroutput"><span class="identifier">write_some</span></code> functions. 64 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> 65 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 66 to the peer, otherwise a non-successful error is associated with the 67 operation. 68 </p> 69<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.h2"></a> 70 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.parameters"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__websocket__stream.accept.overload5.parameters">Parameters</a> 71 </h7><div class="informaltable"><table class="table"> 72<colgroup> 73<col> 74<col> 75</colgroup> 76<thead><tr> 77<th> 78 <p> 79 Name 80 </p> 81 </th> 82<th> 83 <p> 84 Description 85 </p> 86 </th> 87</tr></thead> 88<tbody><tr> 89<td> 90 <p> 91 <code class="computeroutput"><span class="identifier">req</span></code> 92 </p> 93 </td> 94<td> 95 <p> 96 An object containing the HTTP Upgrade request. Ownership is 97 not transferred, the implementation will not access this object 98 from other threads. 99 </p> 100 </td> 101</tr></tbody> 102</table></div> 103<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.h3"></a> 104 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.exceptions"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__websocket__stream.accept.overload5.exceptions">Exceptions</a> 105 </h7><div class="informaltable"><table class="table"> 106<colgroup> 107<col> 108<col> 109</colgroup> 110<thead><tr> 111<th> 112 <p> 113 Type 114 </p> 115 </th> 116<th> 117 <p> 118 Thrown On 119 </p> 120 </th> 121</tr></thead> 122<tbody><tr> 123<td> 124 <p> 125 <code class="computeroutput"><span class="identifier">system_error</span></code> 126 </p> 127 </td> 128<td> 129 <p> 130 Thrown on failure. 131 </p> 132 </td> 133</tr></tbody> 134</table></div> 135<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.h4"></a> 136 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload5.see_also"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__websocket__stream.accept.overload5.see_also">See 137 Also</a> 138 </h7><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 139 <a href="https://tools.ietf.org/html/rfc6455#section-4.2" target="_top">Websocket 140 Opening Handshake Server Requirements (RFC6455)</a> 141 </li></ul></div> 142</div> 143<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 144<td align="left"></td> 145<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 146 Falco<p> 147 Distributed under the Boost Software License, Version 1.0. (See accompanying 148 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>) 149 </p> 150</div></td> 151</tr></table> 152<hr> 153<div class="spirit-nav"> 154<a accesskey="p" href="overload4.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="overload6.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 155</div> 156</body> 157</html> 158
