• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
4<title>buffered_read_stream::capacity</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="../boost__beast__buffered_read_stream.html" title="buffered_read_stream">
9<link rel="prev" href="buffer/overload2.html" title="buffered_read_stream::buffer (2 of 2 overloads)">
10<link rel="next" href="read_some.html" title="buffered_read_stream::read_some">
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="buffer/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__buffered_read_stream.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="read_some.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h5 class="title">
27<a name="beast.ref.boost__beast__buffered_read_stream.capacity"></a><a class="link" href="capacity.html" title="buffered_read_stream::capacity">buffered_read_stream::capacity</a>
28</h5></div></div></div>
29<p>
30          <a class="indexterm" name="idm46057543591136"></a>
31        </p>
32<p>
33          Set the maximum buffer size.
34        </p>
35<h6>
36<a name="beast.ref.boost__beast__buffered_read_stream.capacity.h0"></a>
37          <span class="phrase"><a name="beast.ref.boost__beast__buffered_read_stream.capacity.synopsis"></a></span><a class="link" href="capacity.html#beast.ref.boost__beast__buffered_read_stream.capacity.synopsis">Synopsis</a>
38        </h6>
39<pre class="programlisting"><span class="keyword">void</span>
40<span class="identifier">capacity</span><span class="special">(</span>
41    <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">size</span><span class="special">);</span>
42</pre>
43<h6>
44<a name="beast.ref.boost__beast__buffered_read_stream.capacity.h1"></a>
45          <span class="phrase"><a name="beast.ref.boost__beast__buffered_read_stream.capacity.description"></a></span><a class="link" href="capacity.html#beast.ref.boost__beast__buffered_read_stream.capacity.description">Description</a>
46        </h6>
47<p>
48          This changes the maximum size of the internal buffer used to hold read
49          data. No bytes are discarded by this call. If the buffer size is set to
50          zero, no more data will be buffered. Thread safety: The caller is responsible
51          for making sure the call is made from the same implicit or explicit strand.
52        </p>
53<h6>
54<a name="beast.ref.boost__beast__buffered_read_stream.capacity.h2"></a>
55          <span class="phrase"><a name="beast.ref.boost__beast__buffered_read_stream.capacity.parameters"></a></span><a class="link" href="capacity.html#beast.ref.boost__beast__buffered_read_stream.capacity.parameters">Parameters</a>
56        </h6>
57<div class="informaltable"><table class="table">
58<colgroup>
59<col>
60<col>
61</colgroup>
62<thead><tr>
63<th>
64                  <p>
65                    Name
66                  </p>
67                </th>
68<th>
69                  <p>
70                    Description
71                  </p>
72                </th>
73</tr></thead>
74<tbody><tr>
75<td>
76                  <p>
77                    <code class="computeroutput"><span class="identifier">size</span></code>
78                  </p>
79                </td>
80<td>
81                  <p>
82                    The number of bytes in the read buffer.
83                  </p>
84                </td>
85</tr></tbody>
86</table></div>
87<h6>
88<a name="beast.ref.boost__beast__buffered_read_stream.capacity.h3"></a>
89          <span class="phrase"><a name="beast.ref.boost__beast__buffered_read_stream.capacity.remarks"></a></span><a class="link" href="capacity.html#beast.ref.boost__beast__buffered_read_stream.capacity.remarks">Remarks</a>
90        </h6>
91<p>
92          This is a soft limit. If the new maximum size is smaller than the amount
93          of data in the buffer, no bytes are discarded.
94        </p>
95</div>
96<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
97<td align="left"></td>
98<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
99      Falco<p>
100        Distributed under the Boost Software License, Version 1.0. (See accompanying
101        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>)
102      </p>
103</div></td>
104</tr></table>
105<hr>
106<div class="spirit-nav">
107<a accesskey="p" href="buffer/overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__buffered_read_stream.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="read_some.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
108</div>
109</body>
110</html>
111