MutableBufferSequence.html 4.99 KB
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Mutable buffer sequence requirements</title>
<link rel="stylesheet" href="../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../index.html" title="Asio">
<link rel="up" href="../reference.html" title="Reference">
<link rel="prev" href="MoveAcceptHandler.html" title="Move accept handler requirements">
<link rel="next" href="OperationState.html" title="Operation state concept">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="MoveAcceptHandler.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="OperationState.html"><img src="../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h3 class="title">
<a name="asio.reference.MutableBufferSequence"></a><a class="link" href="MutableBufferSequence.html" title="Mutable buffer sequence requirements">Mutable buffer
      sequence requirements</a>
</h3></div></div></div>
<p>
        A <span class="emphasis"><em>mutable buffer sequence</em></span> represents a set of memory
        regions that may be used to receive the output of an operation, such as the
        <code class="computeroutput">receive</code> operation of a socket.
      </p>
<p>
        A type <code class="computeroutput">X</code> meets the <code class="computeroutput">MutableBufferSequence</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="asio.reference.MutableBufferSequence.t0"></a><p class="title"><b>Table 22. MutableBufferSequence requirements</b></p>
<div class="table-contents"><table class="table" summary="MutableBufferSequence 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">asio::buffer_sequence_begin(x)</code><br> <code class="computeroutput">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">mutable_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(
  asio::buffer_sequence_begin(x),
  asio::buffer_sequence_end(x),
  asio::buffer_sequence_begin(u),
  asio::buffer_sequence_end(u),
  [](const mutable_buffer&amp; b1,
     const mutable_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-2020 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="MoveAcceptHandler.html"><img src="../../prev.png" alt="Prev"></a><a accesskey="u" href="../reference.html"><img src="../../up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../home.png" alt="Home"></a><a accesskey="n" href="OperationState.html"><img src="../../next.png" alt="Next"></a>
</div>
</body>
</html>