doc/html/boost_asio/reference/buffer_size.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>buffer_size</title>
<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="buffer_sequence_end/overload4.html" title="buffer_sequence_end (4 of 4 overloads)">
<link rel="next" href="buffered_read_stream.html" title="buffered_read_stream">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
<td align="center"><a href="../../../../index.html">Home</a></td>
<td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="buffer_sequence_end/overload4.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="buffered_read_stream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_asio.reference.buffer_size"></a><a class="link" href="buffer_size.html" title="buffer_size">buffer_size</a>
</h3></div></div></div>
<p>
        <a class="indexterm" name="boost_asio.indexterm.buffer_size"></a> 
Get the total number of bytes
        in a buffer sequence.
      </p>
<pre class="programlisting">template&lt;
    typename BufferSequence&gt;
std::size_t buffer_size(
    const BufferSequence &amp; b);
</pre>
<p>
        The <code class="computeroutput">buffer_size</code> function determines the total size of all buffers
        in the buffer sequence, as if computed as follows:
      </p>
<pre class="programlisting">size_t total_size = 0;
auto i = boost::asio::buffer_sequence_begin(buffers);
auto end = boost::asio::buffer_sequence_end(buffers);
for (; i != end; ++i)
{
  const_buffer b(*i);
  total_size += b.size();
}
return total_size;
</pre>
<p>
        The <code class="computeroutput">BufferSequence</code> template parameter may meet either of the
        <code class="computeroutput">ConstBufferSequence</code> or <code class="computeroutput">MutableBufferSequence</code> type
        requirements.
      </p>
<h5>
<a name="boost_asio.reference.buffer_size.h0"></a>
        <span class="phrase"><a name="boost_asio.reference.buffer_size.requirements"></a></span><a class="link" href="buffer_size.html#boost_asio.reference.buffer_size.requirements">Requirements</a>
      </h5>
<p>
        <span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/buffer.hpp</code>
      </p>
<p>
        <span class="emphasis"><em>Convenience header: </em></span><code class="literal">boost/asio.hpp</code>
      </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2018 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        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>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="buffer_sequence_end/overload4.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../boost_asio.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="buffered_read_stream.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>