summaryrefslogtreecommitdiff
path: root/doc/html/boost/container/pmr/unsynchronized_idp56479344.html
blob: 4ecd131e2cc87856b161afb6f216e07d39681f1b (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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Class unsynchronized_pool_resource</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="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../../../boost_container_header_reference.html#header.boost.container.pmr.unsynchronized_pool_resource_hpp" title="Header &lt;boost/container/pmr/unsynchronized_pool_resource.hpp&gt;">
<link rel="prev" href="synchronized_pool_resource.html" title="Class synchronized_pool_resource">
<link rel="next" href="../scoped_allocator_adaptor.html" title="Class template scoped_allocator_adaptor">
</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="synchronized_pool_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.unsynchronized_pool_resource_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../scoped_allocator_adaptor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
<div class="refentry">
<a name="boost.container.pmr.unsynchronized_idp56479344"></a><div class="titlepage"></div>
<div class="refnamediv">
<h2><span class="refentrytitle">Class unsynchronized_pool_resource</span></h2>
<p>boost::container::pmr::unsynchronized_pool_resource</p>
</div>
<h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
<div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: &lt;<a class="link" href="../../../boost_container_header_reference.html#header.boost.container.pmr.unsynchronized_pool_resource_hpp" title="Header &lt;boost/container/pmr/unsynchronized_pool_resource.hpp&gt;">boost/container/pmr/unsynchronized_pool_resource.hpp</a>&gt;

</span>
<span class="keyword">class</span> <a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> <span class="special">:</span>
  <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">container</span><span class="special">::</span><span class="identifier">pmr</span><span class="special">::</span><span class="identifier">memory_resource</span>
<span class="special">{</span>
<span class="keyword">public</span><span class="special">:</span>
  <span class="comment">// <a class="link" href="unsynchronized_idp56479344.html#boost.container.pmr.unsynchronized_idp56479344construct-copy-destruct">construct/copy/destruct</a></span>
  <a class="link" href="unsynchronized_idp56479344.html#idp56520240-bb"><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&amp;</span><span class="special">,</span> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  <a class="link" href="unsynchronized_idp56479344.html#idp56526704-bb"><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  <span class="keyword">explicit</span> <a class="link" href="unsynchronized_idp56479344.html#idp56529328-bb"><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  <span class="keyword">explicit</span> <a class="link" href="unsynchronized_idp56479344.html#idp56532592-bb"><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span>
  <a class="link" href="unsynchronized_idp56479344.html#idp56536032-bb"><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  <a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> 
  <a class="link" href="unsynchronized_idp56479344.html#idp56537744-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span>
  <a class="link" href="unsynchronized_idp56479344.html#idp56539888-bb"><span class="special">~</span><span class="identifier">unsynchronized_pool_resource</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="unsynchronized_idp56479344.html#idp56487264-bb">public member functions</a></span>
  <span class="keyword">void</span> <a class="link" href="unsynchronized_idp56479344.html#idp56487824-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <a class="link" href="unsynchronized_idp56479344.html#idp56490688-bb"><span class="identifier">upstream_resource</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <a class="link" href="unsynchronized_idp56479344.html#idp56493136-bb"><span class="identifier">options</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchronized_idp56479344.html#idp56495632-bb"><span class="identifier">pool_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchronized_idp56479344.html#idp56498640-bb"><span class="identifier">pool_index</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchronized_idp56479344.html#idp56504160-bb"><span class="identifier">pool_next_blocks_per_chunk</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchronized_idp56479344.html#idp56509488-bb"><span class="identifier">pool_block</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
  <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="unsynchronized_idp56479344.html#idp56514752-bb"><span class="identifier">pool_cached_blocks</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>

  <span class="comment">// <a class="link" href="unsynchronized_idp56479344.html#idp56541600-bb">protected member functions</a></span>
  <span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="unsynchronized_idp56479344.html#idp56542176-bb"><span class="identifier">do_allocate</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">virtual</span> <span class="keyword">void</span> <a class="link" href="unsynchronized_idp56479344.html#idp56550848-bb"><span class="identifier">do_deallocate</span></a><span class="special">(</span><span class="keyword">void</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="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span>
  <span class="keyword">virtual</span> <span class="keyword">bool</span> <a class="link" href="unsynchronized_idp56479344.html#idp56556432-bb"><span class="identifier">do_is_equal</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span>
<span class="special">}</span><span class="special">;</span></pre></div>
<div class="refsect1">
<a name="id-1.3.10.15.27.3.4"></a><h2>Description</h2>
<p>A <a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> is a general-purpose memory resources having the following qualities:</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><p>Each resource owns the allocated memory, and frees it on destruction, even if deallocate has not been called for some of the allocated blocks.</p></li>
<li class="listitem"><p>A pool resource consists of a collection of pools, serving requests for different block sizes. Each individual pool manages a collection of chunks that are in turn divided into blocks of uniform size, returned via calls to do_allocate. Each call to do_allocate(size, alignment) is dispatched to the pool serving the smallest blocks accommodating at least size bytes.</p></li>
<li class="listitem"><p>When a particular pool is exhausted, allocating a block from that pool results in the allocation of an additional chunk of memory from the upstream allocator (supplied at construction), thus replenishing the pool. With each successive replenishment, the chunk size obtained increases geometrically. [ Note: By allocating memory in chunks, the pooling strategy increases the chance that consecutive allocations will be close together in memory. - end note ]</p></li>
<li class="listitem"><p>Allocation requests that exceed the largest block size of any pool are fulfilled directly from the upstream allocator.</p></li>
<li class="listitem"><p>A <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> struct may be passed to the pool resource constructors to tune the largest block size and the maximum chunk size.</p></li>
</ul></div>
<p>
</p>
<p>An <a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> class may not be accessed from multiple threads simultaneously and thus avoids the cost of synchronization entirely in single-threaded applications. </p>
<div class="refsect2">
<a name="id-1.3.10.15.27.3.4.5"></a><h3>
<a name="boost.container.pmr.unsynchronized_idp56479344construct-copy-destruct"></a><code class="computeroutput">unsynchronized_pool_resource</code> 
        public
       construct/copy/destruct</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><a name="idp56520240-bb"></a><span class="identifier">unsynchronized_pool_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&amp;</span> opts<span class="special">,</span> 
                             <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> upstream<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">upstream</code> is the address of a valid memory resource.</p>
<p><span class="bold"><strong>Effects</strong></span>: Constructs a pool resource object that will obtain memory from upstream whenever the pool resource is unable to satisfy a memory request from its own internal data structures. The resulting object will hold a copy of upstream, but will not own the resource to which upstream points. [ Note: The intention is that calls to upstream-&gt;allocate() will be substantially fewer than calls to this-&gt;allocate() in most cases. - end note The behavior of the pooling mechanism is tuned according to the value of the opts argument.</p>
<p><span class="bold"><strong>Throws</strong></span>: Nothing unless upstream-&gt;allocate() throws. It is unspecified if or under what conditions this constructor calls upstream-&gt;allocate(). </p>
</li>
<li class="listitem">
<pre class="literallayout"><a name="idp56526704-bb"></a><span class="identifier">unsynchronized_pool_resource</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: Same as <code class="computeroutput"><code class="computeroutput"><a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a></code>(pool_options(), get_default_resource())</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56529328-bb"></a><span class="identifier">unsynchronized_pool_resource</span><span class="special">(</span><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> upstream<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: Same as <code class="computeroutput">unsynchronized_pool_resource(pool_options(), upstream)</code>. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56532592-bb"></a><span class="identifier">unsynchronized_pool_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <span class="special">&amp;</span> opts<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: Same as <code class="computeroutput">unsynchronized_pool_resource(opts, get_default_resource())</code>. </p>
</li>
<li class="listitem"><pre class="literallayout"><a name="idp56536032-bb"></a><span class="identifier">unsynchronized_pool_resource</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
<li class="listitem"><pre class="literallayout"><a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> 
<a name="idp56537744-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="unsynchronized_idp56479344.html" title="Class unsynchronized_pool_resource">unsynchronized_pool_resource</a> <span class="special">&amp;</span><span class="special">)</span> <span class="special">=</span> <span class="keyword">delete</span><span class="special">;</span></pre></li>
<li class="listitem">
<pre class="literallayout"><a name="idp56539888-bb"></a><span class="special">~</span><span class="identifier">unsynchronized_pool_resource</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: Calls <code class="computeroutput">this-&gt;release()</code>. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="id-1.3.10.15.27.3.4.6"></a><h3>
<a name="idp56487264-bb"></a><code class="computeroutput">unsynchronized_pool_resource</code> public member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">void</span> <a name="idp56487824-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: Calls Calls <code class="computeroutput">upstream_resource()-&gt;deallocate()</code> as necessary to release all allocated memory. [ Note: memory is released back to <code class="computeroutput">upstream_resource()</code> even if deallocate has not been called for some of the allocated blocks. - end note ] </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">*</span> <a name="idp56490688-bb"></a><span class="identifier">upstream_resource</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns</strong></span>: The value of the upstream argument provided to the constructor of this object. </p>
</li>
<li class="listitem">
<pre class="literallayout"><a class="link" href="pool_options.html" title="Struct pool_options">pool_options</a> <a name="idp56493136-bb"></a><span class="identifier">options</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns</strong></span>: The options that control the pooling behavior of this resource. The values in the returned struct may differ from those supplied to the pool resource constructor in that values of zero will be replaced with implementation-defined defaults and sizes may be rounded to unspecified granularity. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp56495632-bb"></a><span class="identifier">pool_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns</strong></span>: The number of pools that will be used in the pool resource.</p>
<p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp56498640-bb"></a><span class="identifier">pool_index</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns</strong></span>: The index of the pool that will be used to serve the allocation of <code class="computeroutput">bytes</code>. Returns <code class="computeroutput">pool_count()</code> if <code class="computeroutput">bytes</code> is bigger than <code class="computeroutput">options().largest_required_pool_block</code> (no pool will be used to serve this).</p>
<p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp56504160-bb"></a><span class="identifier">pool_next_blocks_per_chunk</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> pool_idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">pool_idx &lt; pool_index()</code></p>
<p><span class="bold"><strong>Returns</strong></span>: The number blocks that will be allocated in the next chunk from the pool specified by <code class="computeroutput">pool_idx</code>.</p>
<p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp56509488-bb"></a><span class="identifier">pool_block</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> pool_idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">pool_idx &lt; pool_index()</code></p>
<p><span class="bold"><strong>Returns</strong></span>: The number of bytes of the block that the specified <code class="computeroutput">pool_idx</code> pool manages.</p>
<p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp56514752-bb"></a><span class="identifier">pool_cached_blocks</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> pool_idx<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Requires</strong></span>: <code class="computeroutput">pool_idx &lt; pool_index()</code></p>
<p><span class="bold"><strong>Returns</strong></span>: The number of blocks that the specified <code class="computeroutput">pool_idx</code> pool has cached and will be served without calling the upstream_allocator.</p>
<p><span class="bold"><strong>Note</strong></span>: Non-standard extension. </p>
</li>
</ol></div>
</div>
<div class="refsect2">
<a name="id-1.3.10.15.27.3.4.7"></a><h3>
<a name="idp56541600-bb"></a><code class="computeroutput">unsynchronized_pool_resource</code> protected member functions</h3>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <span class="special">*</span> <a name="idp56542176-bb"></a><span class="identifier">do_allocate</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns</strong></span>: A pointer to allocated storage with a size of at least <code class="computeroutput">bytes</code>. The size and alignment of the allocated memory shall meet the requirements for a class derived from <code class="computeroutput"><code class="computeroutput"><a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a></code></code>.</p>
<p><span class="bold"><strong>Effects</strong></span>: If the pool selected for a block of size bytes is unable to satisfy the memory request from its own internal data structures, it will call <code class="computeroutput">upstream_resource()-&gt;allocate()</code> to obtain more memory. If <code class="computeroutput">bytes</code> is larger than that which the largest pool can handle, then memory will be allocated using <code class="computeroutput">upstream_resource()-&gt;allocate()</code>.</p>
<p><span class="bold"><strong>Throws</strong></span>: Nothing unless <code class="computeroutput">upstream_resource()-&gt;allocate()</code> throws. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">void</span> <a name="idp56550848-bb"></a><span class="identifier">do_deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> p<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> alignment<span class="special">)</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Effects</strong></span>: Return the memory at p to the pool. It is unspecified if or under what circumstances this operation will result in a call to <code class="computeroutput">upstream_resource()-&gt;deallocate()</code>.</p>
<p><span class="bold"><strong>Throws</strong></span>: Nothing. </p>
</li>
<li class="listitem">
<pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">bool</span> <a name="idp56556432-bb"></a><span class="identifier">do_is_equal</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="memory_resource.html" title="Class memory_resource">memory_resource</a> <span class="special">&amp;</span> other<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre>
<p><span class="bold"><strong>Returns</strong></span>: <code class="computeroutput">this == dynamic_cast&lt;const unsynchronized_pool_resource*&gt;(&amp;other)</code>. </p>
</li>
</ol></div>
</div>
</div>
</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; 2009-2017 Ion
      Gaztanaga<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="synchronized_pool_resource.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../../boost_container_header_reference.html#header.boost.container.pmr.unsynchronized_pool_resource_hpp"><img src="../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="../scoped_allocator_adaptor.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
</div>
</body>
</html>