blob: 80e6241d22172c8fdb856d10f31e01faaebf21ec (
plain)
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
156
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>associated_allocator</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="asio_handler_is_continuation.html" title="asio_handler_is_continuation">
<link rel="next" href="associated_allocator/get.html" title="associated_allocator::get">
</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="asio_handler_is_continuation.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="associated_allocator/get.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.associated_allocator"></a><a class="link" href="associated_allocator.html" title="associated_allocator">associated_allocator</a>
</h3></div></div></div>
<p>
Traits type used to obtain the allocator associated with an object.
</p>
<pre class="programlisting">template<
typename T,
typename Allocator = std::allocator<void>>
struct associated_allocator
</pre>
<h5>
<a name="boost_asio.reference.associated_allocator.h0"></a>
<span class="phrase"><a name="boost_asio.reference.associated_allocator.types"></a></span><a class="link" href="associated_allocator.html#boost_asio.reference.associated_allocator.types">Types</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="associated_allocator/type.html" title="associated_allocator::type"><span class="bold"><strong>type</strong></span></a>
</p>
</td>
<td>
<p>
If T has a nested type allocator_type, T::allocator_type. Otherwise
Allocator.
</p>
</td>
</tr></tbody>
</table></div>
<h5>
<a name="boost_asio.reference.associated_allocator.h1"></a>
<span class="phrase"><a name="boost_asio.reference.associated_allocator.member_functions"></a></span><a class="link" href="associated_allocator.html#boost_asio.reference.associated_allocator.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="associated_allocator/get.html" title="associated_allocator::get"><span class="bold"><strong>get</strong></span></a>
</p>
</td>
<td>
<p>
If T has a nested type allocator_type, returns t.get_allocator().
Otherwise returns a.
</p>
</td>
</tr></tbody>
</table></div>
<p>
A program may specialise this traits type if the <code class="computeroutput">T</code> template
parameter in the specialisation is a user-defined type. The template parameter
<code class="computeroutput">Allocator</code> shall be a type meeting the Allocator requirements.
</p>
<p>
Specialisations shall meet the following requirements, where <code class="computeroutput">t</code>
is a const reference to an object of type <code class="computeroutput">T</code>, and <code class="computeroutput">a</code>
is an object of type <code class="computeroutput">Allocator</code>.
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
Provide a nested typedef <code class="computeroutput">type</code> that identifies a type meeting
the Allocator requirements.
</li>
<li class="listitem">
Provide a noexcept static member function named <code class="computeroutput">get</code>, callable
as <code class="computeroutput">get(t)</code> and with return type <code class="computeroutput">type</code>.
</li>
<li class="listitem">
Provide a noexcept static member function named <code class="computeroutput">get</code>, callable
as <code class="computeroutput">get(t,a)</code> and with return type <code class="computeroutput">type</code>.
</li>
</ul></div>
<h5>
<a name="boost_asio.reference.associated_allocator.h2"></a>
<span class="phrase"><a name="boost_asio.reference.associated_allocator.requirements"></a></span><a class="link" href="associated_allocator.html#boost_asio.reference.associated_allocator.requirements">Requirements</a>
</h5>
<p>
<span class="emphasis"><em>Header: </em></span><code class="literal">boost/asio/associated_allocator.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 © 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="asio_handler_is_continuation.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="associated_allocator/get.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>
|
