boost/doc/html/boost_asio/reference/ConstBufferSequence.html
2021-10-05 21:37:46 +02:00

138 lines
5.6 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Constant buffer sequence requirements</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="ConnectHandler.html" title="Connect handler requirements">
<link rel="next" href="DynamicBuffer.html" title="Dynamic buffer requirements">
</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="ConnectHandler.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="DynamicBuffer.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.ConstBufferSequence"></a><a class="link" href="ConstBufferSequence.html" title="Constant buffer sequence requirements">Constant buffer
sequence requirements</a>
</h3></div></div></div>
<p>
A <span class="emphasis"><em>constant buffer sequence</em></span> represents a set of memory
regions that may be used as input to an operation, such as the <code class="computeroutput">send</code>
operation of a socket.
</p>
<p>
A type <code class="computeroutput">X</code> meets the <code class="computeroutput">ConstBufferSequence</code> requirements
if it satisfies the requirements of <code class="computeroutput">Destructible</code> (C++Std [destructible])
and <code class="computeroutput">CopyConstructible</code> (C++Std [copyconstructible]), as well
as the additional requirements listed below.
</p>
<p>
In the table below, <code class="computeroutput">x</code> denotes a (possibly const) value of type
<code class="computeroutput">X</code>, and <code class="computeroutput">u</code> denotes an identifier.
</p>
<div class="table">
<a name="boost_asio.reference.ConstBufferSequence.t0"></a><p class="title"><b>Table 8. ConstBufferSequence requirements</b></p>
<div class="table-contents"><table class="table" summary="ConstBufferSequence requirements">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
expression
</p>
</th>
<th>
<p>
return type
</p>
</th>
<th>
<p>
assertion/note<br> pre/post-condition
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
<code class="computeroutput">boost::asio::buffer_sequence_begin(x)</code><br> <code class="computeroutput">boost::asio::buffer_sequence_end(x)</code>
</p>
</td>
<td>
<p>
An iterator type meeting the requirements for bidirectional iterators
(C++Std [bidirectional.iterators]) whose value type is convertible
to <code class="computeroutput">const_buffer</code>.
</p>
</td>
<td>
</td>
</tr>
<tr>
<td>
<p>
</p>
<pre class="programlisting">X u(x);
</pre>
<p>
</p>
</td>
<td>
</td>
<td>
<p>
post:<br>
</p>
<pre class="programlisting">equal(
boost::asio::buffer_sequence_begin(x),
boost::asio::buffer_sequence_end(x),
boost::asio::buffer_sequence_begin(u),
boost::asio::buffer_sequence_end(u),
[](const const_buffer&amp; b1,
const const_buffer&amp; b2)
{
return b1.data() == b2.data()
&amp;&amp; b1.size() == b2.size();
})
</pre>
<p>
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break">
</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 © 2003-2021 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="ConnectHandler.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="DynamicBuffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>