doc/html/boost_asio/reference/null_buffers/value_type.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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>null_buffers::value_type</title>
<link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="../../../boost_asio.html" title="Boost.Asio">
<link rel="up" href="../null_buffers.html" title="null_buffers">
<link rel="prev" href="end.html" title="null_buffers::end">
<link rel="next" href="../placeholders__bytes_transferred.html" title="placeholders::bytes_transferred">
</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="end.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../null_buffers.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="../placeholders__bytes_transferred.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="boost_asio.reference.null_buffers.value_type"></a><a class="link" href="value_type.html" title="null_buffers::value_type">null_buffers::value_type</a>
</h4></div></div></div>
<p>
          <a class="indexterm" name="idp153068752"></a> 
The type for each element in the list of buffers.
        </p>
<pre class="programlisting"><span class="keyword">typedef</span> <span class="identifier">mutable_buffer</span> <span class="identifier">value_type</span><span class="special">;</span>
</pre>
<h6>
<a name="boost_asio.reference.null_buffers.value_type.h0"></a>
          <span class="phrase"><a name="boost_asio.reference.null_buffers.value_type.member_functions"></a></span><a class="link" href="value_type.html#boost_asio.reference.null_buffers.value_type.member_functions">Member
          Functions</a>
        </h6>
<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="../mutable_buffer/mutable_buffer.html" title="mutable_buffer::mutable_buffer"><span class="bold"><strong>mutable_buffer</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Construct an empty buffer.
                  </p>
                  <p>
                    Construct a buffer to represent a given memory range.
                  </p>
                </td>
</tr></tbody>
</table></div>
<h6>
<a name="boost_asio.reference.null_buffers.value_type.h1"></a>
          <span class="phrase"><a name="boost_asio.reference.null_buffers.value_type.related_functions"></a></span><a class="link" href="value_type.html#boost_asio.reference.null_buffers.value_type.related_functions">Related
          Functions</a>
        </h6>
<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="../mutable_buffer/operator_plus_.html" title="mutable_buffer::operator+"><span class="bold"><strong>operator+</strong></span></a>
                  </p>
                </td>
<td>
                  <p>
                    Create a new modifiable buffer that is offset from the start
                    of another.
                  </p>
                </td>
</tr></tbody>
</table></div>
<p>
          The <a class="link" href="../mutable_buffer.html" title="mutable_buffer"><code class="computeroutput"><span class="identifier">mutable_buffer</span></code></a>
          class provides a safe representation of a buffer that can be modified.
          It does not own the underlying data, and so is cheap to copy or assign.
        </p>
<h6>
<a name="boost_asio.reference.null_buffers.value_type.h2"></a>
          <span class="phrase"><a name="boost_asio.reference.null_buffers.value_type.accessing_buffer_contents"></a></span><a class="link" href="value_type.html#boost_asio.reference.null_buffers.value_type.accessing_buffer_contents">Accessing
          Buffer Contents</a>
        </h6>
<p>
          The contents of a buffer may be accessed using the <a class="link" href="../buffer_size.html" title="buffer_size"><code class="computeroutput"><span class="identifier">buffer_size</span></code></a> and <a class="link" href="../buffer_cast.html" title="buffer_cast"><code class="computeroutput"><span class="identifier">buffer_cast</span></code></a> functions:
        </p>
<pre class="programlisting"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">mutable_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">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer_size</span><span class="special">(</span><span class="identifier">b1</span><span class="special">);</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="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer_cast</span><span class="special">&lt;</span><span class="keyword">unsigned</span> <span class="keyword">char</span><span class="special">*&gt;(</span><span class="identifier">b1</span><span class="special">);</span>
</pre>
<p>
          The <code class="computeroutput"><span class="identifier">boost</span><span class="special">::</span><span class="identifier">asio</span><span class="special">::</span><span class="identifier">buffer_cast</span></code> function permits violations
          of type safety, so uses of it in application code should be carefully considered.
        </p>
<h6>
<a name="boost_asio.reference.null_buffers.value_type.h3"></a>
          <span class="phrase"><a name="boost_asio.reference.null_buffers.value_type.requirements"></a></span><a class="link" href="value_type.html#boost_asio.reference.null_buffers.value_type.requirements">Requirements</a>
        </h6>
<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-2015 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="end.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../null_buffers.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="../placeholders__bytes_transferred.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>