diff options
Diffstat (limited to 'doc/html/boost/interprocess/node_allocator.html')
-rw-r--r--[-rwxr-xr-x] | doc/html/boost/interprocess/node_allocator.html | 122 |
1 files changed, 61 insertions, 61 deletions
diff --git a/doc/html/boost/interprocess/node_allocator.html b/doc/html/boost/interprocess/node_allocator.html index 48df6d4c51..149879ac36 100755..100644 --- a/doc/html/boost/interprocess/node_allocator.html +++ b/doc/html/boost/interprocess/node_allocator.html @@ -6,7 +6,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../boost_interprocess_reference.html#header.boost.interprocess.allocators.node_allocator_hpp" title="Header <boost/interprocess/allocators/node_allocator.hpp>"> -<link rel="prev" href="operator___id980877.html" title="Function template operator!="> +<link rel="prev" href="operator___id987128.html" title="Function template operator!="> <link rel="next" href="node_allocator/rebind.html" title="Struct template rebind"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -20,7 +20,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___id980877.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.allocators.node_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="node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___id987128.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.allocators.node_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="node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.node_allocator"></a><div class="titlepage"></div> @@ -53,163 +53,163 @@ <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="node_allocator.html#boost.interprocess.node_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="node_allocator.html#id981519-bb"><span class="identifier">node_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> - <a class="link" href="node_allocator.html#id981545-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="node_allocator.html#id987770-bb"><span class="identifier">node_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> + <a class="link" href="node_allocator.html#id987796-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> - <a class="link" href="node_allocator.html#id981566-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="node_allocator.html#id987817-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> SegmentManager2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N2<span class="special">></span> node_allocator& - <a class="link" href="node_allocator.html#id981077-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="node_allocator.html#id981603-bb"><span class="special">~</span><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="node_allocator.html#id987328-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="node_allocator.html#id987853-bb"><span class="special">~</span><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="node_allocator.html#id981116-bb">public member functions</a></span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="node_allocator.html#id981120-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="node_allocator.html#id981132-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> - <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#id981144-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> - <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#id981156-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_pointer</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#id981189-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#id981212-bb"><span class="identifier">deallocate_free_blocks</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#id981224-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> - <span class="identifier">const_pointer</span> <a class="link" href="node_allocator.html#id981241-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> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#id981259-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#id981282-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#id981300-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="node_allocator.html#id987367-bb">public member functions</a></span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="node_allocator.html#id987370-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="node_allocator.html#id987382-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> + <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#id987395-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> + <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#id987407-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_pointer</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#id987439-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#id987462-bb"><span class="identifier">deallocate_free_blocks</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#id987474-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> + <span class="identifier">const_pointer</span> <a class="link" href="node_allocator.html#id987492-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> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#id987509-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#id987533-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#id987550-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <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">pair</span><span class="special"><</span> <span class="identifier">pointer</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> - <a class="link" href="node_allocator.html#id981320-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> + <a class="link" href="node_allocator.html#id987570-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> <span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">multiallocation_chain</span> <a class="link" href="node_allocator.html#id981359-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="special">;</span> - <span class="identifier">multiallocation_chain</span> <a class="link" href="node_allocator.html#id981386-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="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#id981411-bb"><span class="identifier">deallocate_many</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#id981433-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">multiallocation_chain</span> <a class="link" href="node_allocator.html#id981453-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#id981476-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">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#id981496-bb"><span class="identifier">deallocate_individual</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">multiallocation_chain</span> <a class="link" href="node_allocator.html#id987609-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="special">;</span> + <span class="identifier">multiallocation_chain</span> <a class="link" href="node_allocator.html#id987637-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="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#id987662-bb"><span class="identifier">deallocate_many</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#id987684-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">multiallocation_chain</span> <a class="link" href="node_allocator.html#id987704-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#id987727-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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#id987747-bb"><span class="identifier">deallocate_individual</span></a><span class="special">(</span><span class="identifier">multiallocation_chain</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="node_allocator.html#id981609-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="node_allocator.html#id981612-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="node_allocator.html#id987860-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="node_allocator.html#id987863-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="id1756207"></a><h2>Description</h2> +<a name="id1774153"></a><h2>Description</h2> <p>An STL node 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... This node allocator shares a segregated storage between all instances of <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> with equal sizeof(T) placed in the same segment group. NodesPerBlock is the number of nodes allocated at once when the allocator needs runs out of nodes </p> <div class="refsect2"> -<a name="id1756229"></a><h3> +<a name="id1774176"></a><h3> <a name="boost.interprocess.node_allocatorconstruct-copy-destruct"></a><code class="computeroutput">node_allocator</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="id981519-bb"></a><span class="identifier">node_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> +<pre class="literallayout"><a name="id987770-bb"></a><span class="identifier">node_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> <p>Not assignable from other <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code> Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="id981545-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="id987796-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from other <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code>. Increments the reference count of the associated node pool. Never throws </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> - <a name="id981566-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> + <a name="id987817-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from related <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> SegmentManager2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N2<span class="special">></span> - node_allocator& <a name="id981077-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> + node_allocator& <a name="id987328-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from related <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="id981603-bb"></a><span class="special">~</span><span class="identifier">node_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="id987853-bb"></a><span class="special">~</span><span class="identifier">node_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="id1756698"></a><h3> -<a name="id981116-bb"></a><code class="computeroutput">node_allocator</code> public member functions</h3> +<a name="id1774644"></a><h3> +<a name="id987367-bb"></a><code class="computeroutput">node_allocator</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="id981120-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="id987370-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a pointer to the node pool. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="id981132-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> +<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="id987382-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> <p>Returns the segment manager. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="id981144-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> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id987395-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> <p>Returns the number of elements that could be allocated. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <a name="id981156-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_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="id987407-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_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocate 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> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id981189-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id987439-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span><span class="special">;</span></pre> <p>Deallocate allocated memory. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id981212-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id987462-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Deallocates all free blocks of the pool </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <a name="id981224-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> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="id987474-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> <p>Returns address of mutable object. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="id981241-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> +<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="id987492-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> <p>Returns address of non mutable object. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id981259-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id987509-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> <p>Copy construct an object. Throws if T's copy constructor throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id981282-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id987533-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> <p>Destroys object. Throws if object's destructor throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="id981300-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="id987550-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <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> </li> <li class="listitem"><pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">pointer</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> -<a name="id981320-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> +<a name="id987570-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> <span class="identifier">size_type</span> limit_size<span class="special">,</span> <span class="identifier">size_type</span> preferred_size<span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span> received_size<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> reuse <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> <pre class="literallayout"><span class="identifier">multiallocation_chain</span> -<a name="id981359-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><span class="special">;</span></pre> +<a name="id987609-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><span class="special">;</span></pre> <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> </li> <li class="listitem"> <pre class="literallayout"><span class="identifier">multiallocation_chain</span> -<a name="id981386-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><span class="special">;</span></pre> +<a name="id987637-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><span class="special">;</span></pre> <p>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id981411-bb"></a><span class="identifier">deallocate_many</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> chain<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id987662-bb"></a><span class="identifier">deallocate_many</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> chain<span class="special">)</span><span class="special">;</span></pre> <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> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <a name="id981433-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="id987684-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <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> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">multiallocation_chain</span> <a name="id981453-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">multiallocation_chain</span> <a name="id987704-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">)</span><span class="special">;</span></pre> <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> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id981476-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">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id987727-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">&</span> p<span class="special">)</span><span class="special">;</span></pre> <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> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="id981496-bb"></a><span class="identifier">deallocate_individual</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> chain<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="id987747-bb"></a><span class="identifier">deallocate_individual</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> chain<span class="special">)</span><span class="special">;</span></pre> <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> </li> </ol></div> </div> <div class="refsect2"> -<a name="id1757862"></a><h3> -<a name="id981609-bb"></a><code class="computeroutput">node_allocator</code> friend functions</h3> +<a name="id1775807"></a><h3> +<a name="id987860-bb"></a><code class="computeroutput">node_allocator</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="id981612-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="id987863-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre> <p>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </p> </li></ol></div> </div> @@ -225,7 +225,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___id980877.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.allocators.node_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="node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___id987128.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_reference.html#header.boost.interprocess.allocators.node_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="node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> |