1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::close (2 of 2 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="../close.html" title="websocket::stream::close"> 9<link rel="prev" href="overload1.html" title="websocket::stream::close (1 of 2 overloads)"> 10<link rel="next" href="../async_close.html" title="websocket::stream::async_close"> 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="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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_close.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.close.overload2"></a><a class="link" href="overload2.html" title="websocket::stream::close (2 of 2 overloads)">websocket::stream::close 28 (2 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Send a websocket close control frame. 32 </p> 33<h7><a name="beast.ref.boost__beast__websocket__stream.close.overload2.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.close.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.close.overload2.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">void</span> 36<span class="identifier">close</span><span class="special">(</span> 37 <span class="identifier">close_reason</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">cr</span><span class="special">,</span> 38 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> 39</pre> 40<h7><a name="beast.ref.boost__beast__websocket__stream.close.overload2.h1"></a> 41 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.close.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.close.overload2.description">Description</a> 42 </h7><p> 43 This function is used to send a <a href="https://tools.ietf.org/html/rfc6455#section-5.5.1" target="_top">close 44 frame</a>, which begins the websocket closing handshake. The session 45 ends when both ends of the connection have sent and received a close 46 frame. The call blocks until one of the following conditions is true: 47 </p> 48<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 49<li class="listitem"> 50 The close frame is written. 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">write_some</span></code> 59 function. After beginning the closing handshake, the program should not 60 write further message data, pings, or pongs. Instead, the program should 61 continue reading message data until an error occurs. A read returning 62 <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">closed</span></code></a> indicates a successful 63 connection closure. 64 </p> 65<h7><a name="beast.ref.boost__beast__websocket__stream.close.overload2.h2"></a> 66 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.close.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.close.overload2.parameters">Parameters</a> 67 </h7><div class="informaltable"><table class="table"> 68<colgroup> 69<col> 70<col> 71</colgroup> 72<thead><tr> 73<th> 74 <p> 75 Name 76 </p> 77 </th> 78<th> 79 <p> 80 Description 81 </p> 82 </th> 83</tr></thead> 84<tbody> 85<tr> 86<td> 87 <p> 88 <code class="computeroutput"><span class="identifier">cr</span></code> 89 </p> 90 </td> 91<td> 92 <p> 93 The reason for the close. If the close reason specifies a close 94 code other than beast::websocket::close_code::none, the close 95 frame is sent with the close code and optional reason string. 96 Otherwise, the close frame is sent with no payload. 97 </p> 98 </td> 99</tr> 100<tr> 101<td> 102 <p> 103 <code class="computeroutput"><span class="identifier">ec</span></code> 104 </p> 105 </td> 106<td> 107 <p> 108 Set to indicate what error occurred, if any. 109 </p> 110 </td> 111</tr> 112</tbody> 113</table></div> 114<h7><a name="beast.ref.boost__beast__websocket__stream.close.overload2.h3"></a> 115 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.close.overload2.see_also"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__websocket__stream.close.overload2.see_also">See 116 Also</a> 117 </h7><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"> 118 <a href="https://tools.ietf.org/html/rfc6455#section-7.1.2" target="_top">Websocket 119 Closing Handshake (RFC6455)</a> 120 </li></ul></div> 121</div> 122<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 123<td align="left"></td> 124<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 125 Falco<p> 126 Distributed under the Boost Software License, Version 1.0. (See accompanying 127 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>) 128 </p> 129</div></td> 130</tr></table> 131<hr> 132<div class="spirit-nav"> 133<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../close.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_close.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 134</div> 135</body> 136</html> 137
