libs/beast/doc/html/beast/ref/boost__beast__flat_static_buffer_base/reset.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>flat_static_buffer_base::reset</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__flat_static_buffer_base.html" title="flat_static_buffer_base">
   9 <link rel="prev" href="prepare.html" title="flat_static_buffer_base::prepare">
  10 <link rel="next" href="size.html" title="flat_static_buffer_base::size">
  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="prepare.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__flat_static_buffer_base.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="size.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__flat_static_buffer_base.reset"></a><a class="link" href="reset.html" title="flat_static_buffer_base::reset">flat_static_buffer_base::reset</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873508257360"></a>
  31 Reset the pointed-to buffer.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__flat_static_buffer_base.reset.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__flat_static_buffer_base.reset.synopsis"></a></span><a class="link" href="reset.html#beast.ref.boost__beast__flat_static_buffer_base.reset.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">void</span>
  38 <span class="identifier">reset</span><span class="special">(</span>
  39     <span class="keyword">void</span><span class="special">*</span> <span class="identifier">p</span><span class="special">,</span>
  40     <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">n</span><span class="special">);</span>
  41 </pre>
  42 <h6>
  43 <a name="beast.ref.boost__beast__flat_static_buffer_base.reset.h1"></a>
  44           <span class="phrase"><a name="beast.ref.boost__beast__flat_static_buffer_base.reset.description"></a></span><a class="link" href="reset.html#beast.ref.boost__beast__flat_static_buffer_base.reset.description">Description</a>
  45         </h6>
  46 <p>
  47           This function resets the internal state to the buffer provided. All input
  48           and output sequences are invalidated. This function allows the derived
  49           class to construct its members before initializing the static buffer.
  50         </p>
  51 <h6>
  52 <a name="beast.ref.boost__beast__flat_static_buffer_base.reset.h2"></a>
  53           <span class="phrase"><a name="beast.ref.boost__beast__flat_static_buffer_base.reset.parameters"></a></span><a class="link" href="reset.html#beast.ref.boost__beast__flat_static_buffer_base.reset.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>
  73 <tr>
  74 <td>
  75                   <p>
  76                     <code class="computeroutput"><span class="identifier">p</span></code>
  77                   </p>
  78                 </td>
  79 <td>
  80                   <p>
  81                     A pointer to valid storage of at least <code class="computeroutput"><span class="identifier">n</span></code>
  82                     bytes.
  83                   </p>
  84                 </td>
  85 </tr>
  86 <tr>
  87 <td>
  88                   <p>
  89                     <code class="computeroutput"><span class="identifier">n</span></code>
  90                   </p>
  91                 </td>
  92 <td>
  93                   <p>
  94                     The number of valid bytes pointed to by <code class="computeroutput"><span class="identifier">p</span></code>.
  95                   </p>
  96                 </td>
  97 </tr>
  98 </tbody>
  99 </table></div>
 100 <h6>
 101 <a name="beast.ref.boost__beast__flat_static_buffer_base.reset.h3"></a>
 102           <span class="phrase"><a name="beast.ref.boost__beast__flat_static_buffer_base.reset.exception_safety"></a></span><a class="link" href="reset.html#beast.ref.boost__beast__flat_static_buffer_base.reset.exception_safety">Exception
 103           Safety</a>
 104         </h6>
 105 <p>
 106           No-throw guarantee.
 107         </p>
 108 </div>
 109 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 110 <td align="left"></td>
 111 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 112       Falco<p>
 113         Distributed under the Boost Software License, Version 1.0. (See accompanying
 114         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>)
 115       </p>
 116 </div></td>
 117 </tr></table>
 118 <hr>
 119 <div class="spirit-nav">
 120 <a accesskey="p" href="prepare.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__flat_static_buffer_base.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="size.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 121 </div>
 122 </body>
 123 </html>