libs/beast/doc/html/beast/ref/boost__beast__buffers_cat.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>buffers_cat</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="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="boost__beast__buffers_adaptor__readable_bytes.html" title="buffers_adaptor::readable_bytes">
  10 <link rel="next" href="boost__beast__buffers_cat_view.html" title="buffers_cat_view">
  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="boost__beast__buffers_adaptor__readable_bytes.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__buffers_cat_view.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="beast.ref.boost__beast__buffers_cat"></a><a class="link" href="boost__beast__buffers_cat.html" title="buffers_cat">buffers_cat</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873512627584"></a>
  31 Concatenate 1 or more buffer sequences.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__buffers_cat.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__buffers_cat.synopsis"></a></span><a class="link" href="boost__beast__buffers_cat.html#beast.ref.boost__beast__buffers_cat.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/core/buffers_cat.hpp" target="_top">boost/beast/core/buffers_cat.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  41     <span class="keyword">class</span><span class="special">...</span> <a class="link" href="../concepts/BufferSequence.html" title="BufferSequence"><span class="emphasis"><em>BufferSequence</em></span></a><span class="special">&gt;</span>
  42 <span class="identifier">buffers_cat_view</span><span class="special">&lt;</span> <span class="identifier">BufferSequence</span><span class="special">...</span> <span class="special">&gt;</span>
  43 <span class="identifier">buffers_cat</span><span class="special">(</span>
  44     <span class="identifier">BufferSequence</span> <span class="keyword">const</span><span class="special">&amp;...</span> <span class="identifier">buffers</span><span class="special">);</span>
  45 </pre>
  46 <h5>
  47 <a name="beast.ref.boost__beast__buffers_cat.h1"></a>
  48         <span class="phrase"><a name="beast.ref.boost__beast__buffers_cat.description"></a></span><a class="link" href="boost__beast__buffers_cat.html#beast.ref.boost__beast__buffers_cat.description">Description</a>
  49       </h5>
  50 <p>
  51         This function returns a constant or mutable buffer sequence which, when iterated,
  52         efficiently concatenates the input buffer sequences. Copies of the arguments
  53         passed will be made; however, the returned object does not take ownership
  54         of the underlying memory. The application is still responsible for managing
  55         the lifetime of the referenced memory.
  56       </p>
  57 <h5>
  58 <a name="beast.ref.boost__beast__buffers_cat.h2"></a>
  59         <span class="phrase"><a name="beast.ref.boost__beast__buffers_cat.parameters"></a></span><a class="link" href="boost__beast__buffers_cat.html#beast.ref.boost__beast__buffers_cat.parameters">Parameters</a>
  60       </h5>
  61 <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">buffers</span></code>
  82                 </p>
  83               </td>
  84 <td>
  85                 <p>
  86                   The list of buffer sequences to concatenate.
  87                 </p>
  88               </td>
  89 </tr></tbody>
  90 </table></div>
  91 <h5>
  92 <a name="beast.ref.boost__beast__buffers_cat.h3"></a>
  93         <span class="phrase"><a name="beast.ref.boost__beast__buffers_cat.return_value"></a></span><a class="link" href="boost__beast__buffers_cat.html#beast.ref.boost__beast__buffers_cat.return_value">Return
  94         Value</a>
  95       </h5>
  96 <p>
  97         A new buffer sequence that represents the concatenation of the input buffer
  98         sequences. This buffer sequence will be a <span class="emphasis"><em>MutableBufferSequence</em></span>
  99         if each of the passed buffer sequences is also a <span class="emphasis"><em>MutableBufferSequence</em></span>;
 100         otherwise the returned buffer sequence will be a <span class="emphasis"><em>ConstBufferSequence</em></span>.
 101       </p>
 102 <h5>
 103 <a name="beast.ref.boost__beast__buffers_cat.h4"></a>
 104         <span class="phrase"><a name="beast.ref.boost__beast__buffers_cat.see_also"></a></span><a class="link" href="boost__beast__buffers_cat.html#beast.ref.boost__beast__buffers_cat.see_also">See
 105         Also</a>
 106       </h5>
 107 <p>
 108         <a class="link" href="boost__beast__buffers_cat_view.html" title="buffers_cat_view"><code class="computeroutput"><span class="identifier">buffers_cat_view</span></code></a>
 109       </p>
 110 <p>
 111         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/core.hpp" target="_top">boost/beast/core.hpp</a>&gt;</code>
 112       </p>
 113 </div>
 114 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 115 <td align="left"></td>
 116 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 117       Falco<p>
 118         Distributed under the Boost Software License, Version 1.0. (See accompanying
 119         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>)
 120       </p>
 121 </div></td>
 122 </tr></table>
 123 <hr>
 124 <div class="spirit-nav">
 125 <a accesskey="p" href="boost__beast__buffers_adaptor__readable_bytes.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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="boost__beast__buffers_cat_view.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 126 </div>
 127 </body>
 128 </html>