186 lines
8.3 KiB
HTML
186 lines
8.3 KiB
HTML
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
||
|
|
<title>const_buffer</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="consign_t/consign_t.html" title="consign_t::consign_t">
|
||
|
|
<link rel="next" href="const_buffer/const_buffer.html" title="const_buffer::const_buffer">
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
|
|
</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="consign_t/consign_t.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="const_buffer/const_buffer.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
<div class="section">
|
||
|
|
<div class="titlepage"><div><div><h3 class="title">
|
||
|
|
<a name="asio.reference.const_buffer"></a><a class="link" href="const_buffer.html" title="const_buffer">const_buffer</a>
|
||
|
|
</h3></div></div></div>
|
||
|
|
<p>
|
||
|
|
<a class="indexterm" name="asio.indexterm.const_buffer"></a>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
Holds a buffer that cannot be modified.
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">const_buffer</span>
|
||
|
|
</pre>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.const_buffer.h0"></a>
|
||
|
|
<span><a name="asio.reference.const_buffer.member_functions"></a></span><a class="link" href="const_buffer.html#asio.reference.const_buffer.member_functions">Member
|
||
|
|
Functions</a>
|
||
|
|
</h5>
|
||
|
|
<div class="informaltable"><table class="table">
|
||
|
|
<colgroup>
|
||
|
|
<col>
|
||
|
|
<col>
|
||
|
|
</colgroup>
|
||
|
|
<thead><tr>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Name
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Description
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
</tr></thead>
|
||
|
|
<tbody>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="const_buffer/const_buffer.html" title="const_buffer::const_buffer"><span class="bold"><strong>const_buffer</strong></span></a> <span class="silver">[constructor]</span>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Construct an empty buffer. <br> <span class="silver"> —</span><br> Construct a buffer to
|
||
|
|
represent a given memory range. <br> <span class="silver"> —</span><br> Construct a non-modifiable
|
||
|
|
buffer from a modifiable one.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="const_buffer/data.html" title="const_buffer::data"><span class="bold"><strong>data</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Get a pointer to the beginning of the memory range.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="const_buffer/operator_plus__eq_.html" title="const_buffer::operator+="><span class="bold"><strong>operator+=</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Move the start of the buffer by the specified number of bytes.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="const_buffer/size.html" title="const_buffer::size"><span class="bold"><strong>size</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Get the size of the memory range.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table></div>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.const_buffer.h1"></a>
|
||
|
|
<span><a name="asio.reference.const_buffer.related_functions"></a></span><a class="link" href="const_buffer.html#asio.reference.const_buffer.related_functions">Related
|
||
|
|
Functions</a>
|
||
|
|
</h5>
|
||
|
|
<div class="informaltable"><table class="table">
|
||
|
|
<colgroup>
|
||
|
|
<col>
|
||
|
|
<col>
|
||
|
|
</colgroup>
|
||
|
|
<thead><tr>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Name
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
<th>
|
||
|
|
<p>
|
||
|
|
Description
|
||
|
|
</p>
|
||
|
|
</th>
|
||
|
|
</tr></thead>
|
||
|
|
<tbody><tr>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
<a class="link" href="const_buffer/operator_plus_.html" title="const_buffer::operator+"><span class="bold"><strong>operator+</strong></span></a>
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
<td>
|
||
|
|
<p>
|
||
|
|
Create a new non-modifiable buffer that is offset from the start
|
||
|
|
of another.
|
||
|
|
</p>
|
||
|
|
</td>
|
||
|
|
</tr></tbody>
|
||
|
|
</table></div>
|
||
|
|
<p>
|
||
|
|
The <a class="link" href="const_buffer.html" title="const_buffer"><code class="computeroutput"><span class="identifier">const_buffer</span></code></a>
|
||
|
|
class provides a safe representation of a buffer that cannot be modified.
|
||
|
|
It does not own the underlying data, and so is cheap to copy or assign.
|
||
|
|
</p>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.const_buffer.h2"></a>
|
||
|
|
<span><a name="asio.reference.const_buffer.accessing_buffer_contents"></a></span><a class="link" href="const_buffer.html#asio.reference.const_buffer.accessing_buffer_contents">Accessing
|
||
|
|
Buffer Contents</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
The contents of a buffer may be accessed using the <code class="computeroutput"><span class="identifier">data</span><span class="special">()</span></code> and <code class="computeroutput"><span class="identifier">size</span><span class="special">()</span></code> member functions:
|
||
|
|
</p>
|
||
|
|
<pre class="programlisting"><span class="identifier">asio</span><span class="special">::</span><span class="identifier">const_buffer</span> <span class="identifier">b1</span> <span class="special">=</span> <span class="special">...;</span>
|
||
|
|
<span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">s1</span> <span class="special">=</span> <span class="identifier">b1</span><span class="special">.</span><span class="identifier">size</span><span class="special">();</span>
|
||
|
|
<span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">*</span> <span class="identifier">p1</span> <span class="special">=</span> <span class="keyword">static_cast</span><span class="special"><</span><span class="keyword">const</span> <span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">*>(</span><span class="identifier">b1</span><span class="special">.</span><span class="identifier">data</span><span class="special">());</span>
|
||
|
|
</pre>
|
||
|
|
<p>
|
||
|
|
The <code class="computeroutput"><span class="identifier">data</span><span class="special">()</span></code>
|
||
|
|
member function permits violations of type safety, so uses of it in application
|
||
|
|
code should be carefully considered.
|
||
|
|
</p>
|
||
|
|
<h5>
|
||
|
|
<a name="asio.reference.const_buffer.h3"></a>
|
||
|
|
<span><a name="asio.reference.const_buffer.requirements"></a></span><a class="link" href="const_buffer.html#asio.reference.const_buffer.requirements">Requirements</a>
|
||
|
|
</h5>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Header: </em></span><code class="literal">asio/buffer.hpp</code>
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
<span class="emphasis"><em>Convenience header: </em></span><code class="literal">asio.hpp</code>
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<div class="copyright-footer">Copyright © 2003-2023 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>
|
||
|
|
<hr>
|
||
|
|
<div class="spirit-nav">
|
||
|
|
<a accesskey="p" href="consign_t/consign_t.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="const_buffer/const_buffer.html"><img src="../../next.png" alt="Next"></a>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|