libs/beast/doc/html/beast/ref/boost__beast__buffered_read_stream/capacity.html

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