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