1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::accept (1 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="../accept.html" title="websocket::stream::accept"> 10<link rel="next" href="overload2.html" title="websocket::stream::accept (2 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="../accept.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="overload2.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.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::accept (1 of 6 overloads)">websocket::stream::accept 28 (1 of 6 overloads)</a> 29</h6></div></div></div> 30<p> 31 Perform the WebSocket handshake in the server role. 32 </p> 33<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.accept.overload1.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">void</span> 36<span class="identifier">accept</span><span class="special">();</span> 37</pre> 38<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.h1"></a> 39 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.accept.overload1.description">Description</a> 40 </h7><p> 41 This function is used to perform the <a href="https://en.wikipedia.org/wiki/WebSocket#Protocol_handshake" target="_top">WebSocket 42 handshake</a>, required before messages can be sent and received. 43 During the handshake, the client sends the Websocket Upgrade HTTP request, 44 and the server replies with an HTTP response indicating the result of 45 the handshake. The call blocks until one of the following conditions 46 is true: 47 </p> 48<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 49<li class="listitem"> 50 The request is received and the response is sent. 51 </li> 52<li class="listitem"> 53 An error occurs. 54 </li> 55</ul></div> 56<p> 57 The algorithm, known as a <span class="emphasis"><em>composed operation</em></span>, is 58 implemented in terms of calls to the next layer's <code class="computeroutput"><span class="identifier">read_some</span></code> 59 and <code class="computeroutput"><span class="identifier">write_some</span></code> functions. 60 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> 61 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 62 to the peer, otherwise a non-successful error is associated with the 63 operation. If the request size exceeds the capacity of the stream's internal 64 buffer, the error <a class="link" href="../../boost__beast__websocket__error.html" title="websocket::error"><code class="computeroutput"><span class="identifier">error</span><span class="special">::</span><span class="identifier">buffer_overflow</span></code></a> will be indicated. 65 To handle larger requests, an application should read the HTTP request 66 directly using <a class="link" href="../../boost__beast__http__read/overload1.html" title="http::read (1 of 4 overloads)"><code class="computeroutput"> 67 <span class="identifier">http</span><span class="special">::</span><span class="identifier">read</span> </code></a> and then pass the request 68 to the appropriate overload of <a class="link" href="overload1.html" title="websocket::stream::accept (1 of 6 overloads)"><code class="computeroutput"><span class="identifier">accept</span></code></a> or <a class="link" href="../async_accept/overload1.html" title="websocket::stream::async_accept (1 of 3 overloads)"><code class="computeroutput"><span class="identifier">async_accept</span></code></a> 69 </p> 70<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.h2"></a> 71 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.exceptions"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.accept.overload1.exceptions">Exceptions</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 Type 81 </p> 82 </th> 83<th> 84 <p> 85 Thrown On 86 </p> 87 </th> 88</tr></thead> 89<tbody><tr> 90<td> 91 <p> 92 <code class="computeroutput"><span class="identifier">system_error</span></code> 93 </p> 94 </td> 95<td> 96 <p> 97 Thrown on failure. 98 </p> 99 </td> 100</tr></tbody> 101</table></div> 102<h7><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.h3"></a> 103 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.accept.overload1.see_also"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.accept.overload1.see_also">See 104 Also</a> 105 </h7><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 106 <a href="https://tools.ietf.org/html/rfc6455#section-4.2" target="_top">Websocket 107 Opening Handshake Server Requirements (RFC6455)</a> 108 </li></ul></div> 109</div> 110<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 111<td align="left"></td> 112<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 113 Falco<p> 114 Distributed under the Boost Software License, Version 1.0. (See accompanying 115 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>) 116 </p> 117</div></td> 118</tr></table> 119<hr> 120<div class="spirit-nav"> 121<a accesskey="p" href="../accept.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="overload2.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 122</div> 123</body> 124</html> 125
