1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>websocket::stream::write_buffer_bytes (1 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="../write_buffer_bytes.html" title="websocket::stream::write_buffer_bytes"> 9<link rel="prev" href="../write_buffer_bytes.html" title="websocket::stream::write_buffer_bytes"> 10<link rel="next" href="overload2.html" title="websocket::stream::write_buffer_bytes (2 of 2 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="../write_buffer_bytes.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_buffer_bytes.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.write_buffer_bytes.overload1"></a><a class="link" href="overload1.html" title="websocket::stream::write_buffer_bytes (1 of 2 overloads)">websocket::stream::write_buffer_bytes 28 (1 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Set the write buffer size option. 32 </p> 33<h7><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">void</span> 36<span class="identifier">write_buffer_bytes</span><span class="special">(</span> 37 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">amount</span><span class="special">);</span> 38</pre> 39<h7><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.h1"></a> 40 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.description">Description</a> 41 </h7><p> 42 Sets the size of the write buffer used by the implementation to send 43 frames. The write buffer is needed when masking payload data in the client 44 role, compressing frames, or auto-fragmenting message data. Lowering 45 the size of the buffer can decrease the memory requirements for each 46 connection, while increasing the size of the buffer can reduce the number 47 of calls made to the next layer to write data. The default setting is 48 4096. The minimum value is 8. The write buffer size can only be changed 49 when the stream is not open. Undefined behavior results if the option 50 is modified after a successful WebSocket handshake. 51 </p> 52<h7><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.h2"></a> 53 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.example"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.example">Example</a> 54 </h7><p> 55 Setting the write buffer size. 56 </p> 57<pre class="programlisting"><span class="identifier">ws</span><span class="special">.</span><span class="identifier">write_buffer_bytes</span><span class="special">(</span><span class="number">8192</span><span class="special">);</span> 58</pre> 59<h7><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.h3"></a> 60 <span class="phrase"><a name="beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__websocket__stream.write_buffer_bytes.overload1.parameters">Parameters</a> 61 </h7><div class="informaltable"><table class="table"> 62<colgroup> 63<col> 64<col> 65</colgroup> 66<thead><tr> 67<th> 68 <p> 69 Name 70 </p> 71 </th> 72<th> 73 <p> 74 Description 75 </p> 76 </th> 77</tr></thead> 78<tbody><tr> 79<td> 80 <p> 81 <code class="computeroutput"><span class="identifier">amount</span></code> 82 </p> 83 </td> 84<td> 85 <p> 86 The size of the write buffer in bytes. 87 </p> 88 </td> 89</tr></tbody> 90</table></div> 91</div> 92<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 93<td align="left"></td> 94<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 95 Falco<p> 96 Distributed under the Boost Software License, Version 1.0. (See accompanying 97 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>) 98 </p> 99</div></td> 100</tr></table> 101<hr> 102<div class="spirit-nav"> 103<a accesskey="p" href="../write_buffer_bytes.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../write_buffer_bytes.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> 104</div> 105</body> 106</html> 107
