Imported Upstream version 1.64.0
[platform/upstream/boost.git] / doc / html / boost / interprocess / allocator.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5 <title>Class template allocator</title>
6 <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
7 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
8 <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
9 <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp" title="Header &lt;boost/interprocess/allocators/allocator.hpp&gt;">
10 <link rel="prev" href="operator___idp42833104.html" title="Function template operator!=">
11 <link rel="next" href="allocator/rebind.html" title="Struct template rebind">
12 </head>
13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
14 <table cellpadding="2" width="100%"><tr>
15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
16 <td align="center"><a href="../../../../index.html">Home</a></td>
17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
21 </tr></table>
22 <hr>
23 <div class="spirit-nav">
24 <a accesskey="p" href="operator___idp42833104.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_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="allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
25 </div>
26 <div class="refentry">
27 <a name="boost.interprocess.allocator"></a><div class="titlepage"></div>
28 <div class="refnamediv">
29 <h2><span class="refentrytitle">Class template allocator</span></h2>
30 <p>boost::interprocess::allocator</p>
31 </div>
32 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
33 <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="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp" title="Header &lt;boost/interprocess/allocators/allocator.hpp&gt;">boost/interprocess/allocators/allocator.hpp</a>&gt;
34
35 </span><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> SegmentManager<span class="special">&gt;</span> 
36 <span class="keyword">class</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a> <span class="special">{</span>
37 <span class="keyword">public</span><span class="special">:</span>
38   <span class="comment">// types</span>
39   <span class="keyword">typedef</span> <span class="identifier">SegmentManager</span>                                                                        <a name="boost.interprocess.allocator.segment_manager"></a><span class="identifier">segment_manager</span><span class="special">;</span>
40   <span class="keyword">typedef</span> <span class="identifier">SegmentManager</span><span class="special">::</span><span class="identifier">void_pointer</span>                                                          <a name="boost.interprocess.allocator.void_pointer"></a><span class="identifier">void_pointer</span><span class="special">;</span>   
41   <span class="keyword">typedef</span> <span class="identifier">T</span>                                                                                     <a name="boost.interprocess.allocator.value_type"></a><span class="identifier">value_type</span><span class="special">;</span>     
42   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">intrusive</span><span class="special">::</span><span class="identifier">pointer_traits</span><span class="special">&lt;</span> <span class="identifier">cvoid_ptr</span> <span class="special">&gt;</span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">rebind_pointer</span><span class="special">&lt;</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span>     <a name="boost.interprocess.allocator.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>        
43   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">intrusive</span><span class="special">::</span><span class="identifier">pointer_traits</span><span class="special">&lt;</span> <span class="identifier">pointer</span> <span class="special">&gt;</span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">rebind_pointer</span><span class="special">&lt;</span> <span class="keyword">const</span> <span class="identifier">T</span> <span class="special">&gt;</span><span class="special">::</span><span class="identifier">type</span> <a name="boost.interprocess.allocator.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>  
44   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                           <a name="boost.interprocess.allocator.reference"></a><span class="identifier">reference</span><span class="special">;</span>      
45   <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span>                                                                           <a name="boost.interprocess.allocator.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span>
46   <span class="keyword">typedef</span> <span class="identifier">segment_manager</span><span class="special">::</span><span class="identifier">size_type</span>                                                            <a name="boost.interprocess.allocator.size_type"></a><span class="identifier">size_type</span><span class="special">;</span>      
47   <span class="keyword">typedef</span> <span class="identifier">segment_manager</span><span class="special">::</span><span class="identifier">difference_type</span>                                                      <a name="boost.interprocess.allocator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
48   <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">interprocess</span><span class="special">::</span><span class="identifier">version_type</span><span class="special">&lt;</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special">,</span> <span class="number">2</span> <span class="special">&gt;</span>                                     <a name="boost.interprocess.allocator.version"></a><span class="identifier">version</span><span class="special">;</span>        
49
50   <span class="comment">// member classes/structs/unions</span>
51   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span> 
52   <span class="keyword">struct</span> <a class="link" href="allocator/rebind.html" title="Struct template rebind">rebind</a> <span class="special">{</span>
53     <span class="comment">// types</span>
54     <span class="keyword">typedef</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special">&lt;</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">&gt;</span> <a class="link" href="allocator/rebind.html#boost.interprocess.allocator.rebind.other"><span class="identifier">other</span></a><span class="special">;</span>
55   <span class="special">}</span><span class="special">;</span>
56
57   <span class="comment">// <a class="link" href="allocator.html#boost.interprocess.allocatorconstruct-copy-destruct">construct/copy/destruct</a></span>
58   <a class="link" href="allocator.html#idp42903712-bb"><span class="identifier">allocator</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span>
59   <a class="link" href="allocator.html#idp42905136-bb"><span class="identifier">allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
60   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span> <a class="link" href="allocator.html#idp42907008-bb"><span class="identifier">allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special">&lt;</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
61
62   <span class="comment">// <a class="link" href="allocator.html#idp42858480-bb">public member functions</a></span>
63   <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="allocator.html#idp42859040-bb"><span class="identifier">get_segment_manager</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
64   <span class="identifier">pointer</span> <a class="link" href="allocator.html#idp42860608-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">cvoid_ptr</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span>
65   <span class="keyword">void</span> <a class="link" href="allocator.html#idp42864352-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span>
66   <span class="identifier">size_type</span> <a class="link" href="allocator.html#idp42867024-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
67   <span class="identifier">size_type</span> <a class="link" href="allocator.html#idp42868608-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
68   <span class="identifier">pointer</span> <a class="link" href="allocator.html#idp42871008-bb"><span class="identifier">allocation_command</span></a><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">interprocess</span><span class="special">::</span><span class="identifier">allocation_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> 
69                              <span class="identifier">size_type</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
70   <span class="keyword">void</span> <a class="link" href="allocator.html#idp42874640-bb"><span class="identifier">allocate_many</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
71   <span class="keyword">void</span> <a class="link" href="allocator.html#idp42878272-bb"><span class="identifier">allocate_many</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_type</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
72   <span class="keyword">void</span> <a class="link" href="allocator.html#idp42881712-bb"><span class="identifier">deallocate_many</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
73   <span class="identifier">pointer</span> <a class="link" href="allocator.html#idp42883968-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
74   <span class="keyword">void</span> <a class="link" href="allocator.html#idp42886096-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
75   <span class="keyword">void</span> <a class="link" href="allocator.html#idp42889056-bb"><span class="identifier">deallocate_one</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
76   <span class="keyword">void</span> <a class="link" href="allocator.html#idp42891184-bb"><span class="identifier">deallocate_individual</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
77   <span class="identifier">pointer</span> <a class="link" href="allocator.html#idp42893456-bb"><span class="identifier">address</span></a><span class="special">(</span><span class="identifier">reference</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
78   <span class="identifier">const_pointer</span> <a class="link" href="allocator.html#idp42895712-bb"><span class="identifier">address</span></a><span class="special">(</span><span class="identifier">const_reference</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span>
79   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> P<span class="special">&gt;</span> <span class="keyword">void</span> <a class="link" href="allocator.html#idp42897968-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">P</span> <span class="special">&amp;&amp;</span><span class="special">)</span><span class="special">;</span>
80   <span class="keyword">void</span> <a class="link" href="allocator.html#idp42901568-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
81
82   <span class="comment">// <a class="link" href="allocator.html#idp42909744-bb">friend functions</a></span>
83   <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="allocator.html#idp42910304-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&amp;</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
84 <span class="special">}</span><span class="special">;</span></pre></div>
85 <div class="refsect1">
86 <a name="idp275226160"></a><h2>Description</h2>
87 <p>An STL compatible allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc... </p>
88 <div class="refsect2">
89 <a name="idp275227120"></a><h3>
90 <a name="boost.interprocess.allocatorconstruct-copy-destruct"></a><code class="computeroutput">allocator</code> 
91         public
92        construct/copy/destruct</h3>
93 <div class="orderedlist"><ol class="orderedlist" type="1">
94 <li class="listitem">
95 <pre class="literallayout"><a name="idp42903712-bb"></a><span class="identifier">allocator</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre>
96 <p>Constructor from the segment manager. Never throws </p>
97 </li>
98 <li class="listitem">
99 <pre class="literallayout"><a name="idp42905136-bb"></a><span class="identifier">allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
100 <p>Constructor from other allocator. Never throws </p>
101 </li>
102 <li class="listitem">
103 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span> <a name="idp42907008-bb"></a><span class="identifier">allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special">&lt;</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
104 <p>Constructor from related allocator. Never throws </p>
105 </li>
106 </ol></div>
107 </div>
108 <div class="refsect2">
109 <a name="idp275252608"></a><h3>
110 <a name="idp42858480-bb"></a><code class="computeroutput">allocator</code> public member functions</h3>
111 <div class="orderedlist"><ol class="orderedlist" type="1">
112 <li class="listitem">
113 <pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp42859040-bb"></a><span class="identifier">get_segment_manager</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
114 <p>Returns the segment manager. Never throws </p>
115 </li>
116 <li class="listitem">
117 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idp42860608-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_ptr</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre>
118 <p>Allocates memory for an array of count elements. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p>
119 </li>
120 <li class="listitem">
121 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42864352-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> ptr<span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span></pre>
122 <p>Deallocates memory previously allocated. Never throws </p>
123 </li>
124 <li class="listitem">
125 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp42867024-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
126 <p>Returns the number of elements that could be allocated. Never throws </p>
127 </li>
128 <li class="listitem">
129 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idp42868608-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
130 <p>Returns maximum the number of objects the previously allocated memory pointed by p can hold. This size only works for memory allocated with allocate, allocation_command and allocate_many. </p>
131 </li>
132 <li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp42871008-bb"></a><span class="identifier">allocation_command</span><span class="special">(</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">interprocess</span><span class="special">::</span><span class="identifier">allocation_type</span> command<span class="special">,</span> 
133                            <span class="identifier">size_type</span> limit_size<span class="special">,</span> 
134                            <span class="identifier">size_type</span> <span class="special">&amp;</span> prefer_in_recvd_out_size<span class="special">,</span> 
135                            <span class="identifier">pointer</span> <span class="special">&amp;</span> reuse<span class="special">)</span><span class="special">;</span></pre></li>
136 <li class="listitem">
137 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42874640-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">size_type</span> num_elements<span class="special">,</span> 
138                    <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
139 <p>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </p>
140 </li>
141 <li class="listitem">
142 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42878272-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">size_type</span> <span class="special">*</span> elem_sizes<span class="special">,</span> <span class="identifier">size_type</span> n_elements<span class="special">,</span> 
143                    <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
144 <p>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </p>
145 </li>
146 <li class="listitem">
147 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42881712-bb"></a><span class="identifier">deallocate_many</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
148 <p>Allocates many elements of size elem_size in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. The elements must be deallocated with deallocate(...) </p>
149 </li>
150 <li class="listitem">
151 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idp42883968-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
152 <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p>
153 </li>
154 <li class="listitem">
155 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42886096-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">,</span> 
156                          <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
157 <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p>
158 </li>
159 <li class="listitem">
160 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42889056-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>
161 <p>Deallocates memory previously allocated with allocate_one(). You should never use deallocate_one to deallocate memory allocated with other functions different from allocate_one(). Never throws </p>
162 </li>
163 <li class="listitem">
164 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42891184-bb"></a><span class="identifier">deallocate_individual</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
165 <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p>
166 </li>
167 <li class="listitem">
168 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idp42893456-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
169 <p>Returns address of mutable object. Never throws </p>
170 </li>
171 <li class="listitem">
172 <pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idp42895712-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">const_reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>
173 <p>Returns address of non mutable object. Never throws </p>
174 </li>
175 <li class="listitem">
176 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> P<span class="special">&gt;</span> <span class="keyword">void</span> <a name="idp42897968-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> ptr<span class="special">,</span> <span class="identifier">P</span> <span class="special">&amp;&amp;</span> p<span class="special">)</span><span class="special">;</span></pre>
177 <p>Constructs an object Throws if T's constructor throws For backwards compatibility with libraries using C++03 allocators </p>
178 </li>
179 <li class="listitem">
180 <pre class="literallayout"><span class="keyword">void</span> <a name="idp42901568-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&amp;</span> ptr<span class="special">)</span><span class="special">;</span></pre>
181 <p>Destroys object. Throws if object's destructor throws </p>
182 </li>
183 </ol></div>
184 </div>
185 <div class="refsect2">
186 <a name="idp275385328"></a><h3>
187 <a name="idp42909744-bb"></a><code class="computeroutput">allocator</code> friend functions</h3>
188 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
189 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp42910304-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&amp;</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&amp;</span> alloc2<span class="special">)</span><span class="special">;</span></pre>
190 <p>Swap segment manager. Does not throw. If each allocator is placed in different memory segments, the result is undefined. </p>
191 </li></ol></div>
192 </div>
193 </div>
194 </div>
195 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
196 <td align="left"></td>
197 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2015 Ion Gaztanaga<p>
198         Distributed under the Boost Software License, Version 1.0. (See accompanying
199         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>)
200       </p>
201 </div></td>
202 </tr></table>
203 <hr>
204 <div class="spirit-nav">
205 <a accesskey="p" href="operator___idp42833104.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_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="allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
206 </div>
207 </body>
208 </html>