doc/html/boost/interprocess/node_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 node_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.node_allocator_hpp" title="Header &lt;boost/interprocess/allocators/node_allocator.hpp&gt;">
  10 <link rel="prev" href="operator_idm45336642686800.html" title="Function template operator!=">
  11 <link rel="next" href="node_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_idm45336642686800.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_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>
  25 </div>
  26 <div class="refentry">
  27 <a name="boost.interprocess.node_allocator"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">Class template node_allocator</span></h2>
  30 <p>boost::interprocess::node_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.node_allocator_hpp" title="Header &lt;boost/interprocess/allocators/node_allocator.hpp&gt;">boost/interprocess/allocators/node_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">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> NodesPerBlock<span class="special">&gt;</span>
  36 <span class="keyword">class</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_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">implementation_defined</span><span class="special">::</span><span class="identifier">segment_manager</span> <a name="boost.interprocess.node_allocator.segment_manager"></a><span class="identifier">segment_manager</span><span class="special">;</span>
  40   <span class="keyword">typedef</span> <span class="identifier">segment_manager</span><span class="special">::</span><span class="identifier">void_pointer</span>           <a name="boost.interprocess.node_allocator.void_pointer"></a><span class="identifier">void_pointer</span><span class="special">;</span>
  41   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">pointer</span>         <a name="boost.interprocess.node_allocator.pointer"></a><span class="identifier">pointer</span><span class="special">;</span>
  42   <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span><span class="special">::</span><span class="identifier">const_pointer</span>   <a name="boost.interprocess.node_allocator.const_pointer"></a><span class="identifier">const_pointer</span><span class="special">;</span>
  43   <span class="keyword">typedef</span> <span class="identifier">T</span>                                       <a name="boost.interprocess.node_allocator.value_type"></a><span class="identifier">value_type</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.node_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.node_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.node_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.node_allocator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span>
  48
  49   <span class="comment">// member classes/structs/unions</span>
  50   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span>
  51   <span class="keyword">struct</span> <a class="link" href="node_allocator/rebind.html" title="Struct template rebind">rebind</a> <span class="special">{</span>
  52     <span class="comment">// types</span>
  53     <span class="keyword">typedef</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special">&lt;</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">&gt;</span> <a class="link" href="node_allocator/rebind.html#boost.interprocess.node_allocator.rebind.other"><span class="identifier">other</span></a><span class="special">;</span>
  54   <span class="special">}</span><span class="special">;</span>
  55
  56   <span class="comment">// <a class="link" href="node_allocator.html#boost.interprocess.node_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span>
  57   <a class="link" href="node_allocator.html#idm45336642607824-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>
  58   <a class="link" href="node_allocator.html#idm45336642604800-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">&amp;</span><span class="special">)</span><span class="special">;</span>
  59   <span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span>
  60     <a class="link" href="node_allocator.html#idm45336642602144-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">&lt;</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">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  61   <span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
  62     <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span>
  63     <a class="link" href="node_allocator.html#idm45336642660432-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">&lt;</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">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span>
  64   <a class="link" href="node_allocator.html#idm45336642597840-bb"><span class="special">~</span><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  65
  66   <span class="comment">// <a class="link" href="node_allocator.html#idm45336642654992-bb">public member functions</a></span>
  67   <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="node_allocator.html#idm45336642654432-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>
  68   <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="node_allocator.html#idm45336642652864-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>
  69   <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#idm45336642651296-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>
  70   <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idm45336642649712-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>
  71   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642645984-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>
  72   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642643312-bb"><span class="identifier">deallocate_free_blocks</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  73   <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idm45336642642016-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>
  74   <span class="identifier">const_pointer</span> <a class="link" href="node_allocator.html#idm45336642639760-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>
  75   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642637504-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">const_reference</span><span class="special">)</span><span class="special">;</span>
  76   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642634816-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>
  77   <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#idm45336642632832-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>
  78   <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idm45336642630432-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>
  79                              <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>
  80   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642626800-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>
  81   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642623168-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>
  82   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642619728-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>
  83   <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idm45336642617472-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span>
  84   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642615344-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>
  85   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642612384-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>
  86   <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642610256-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>
  87
  88   <span class="comment">// <a class="link" href="node_allocator.html#idm45336642597056-bb">friend functions</a></span>
  89   <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="node_allocator.html#idm45336642596496-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>
  90 <span class="special">}</span><span class="special">;</span></pre></div>
  91 <div class="refsect1">
  92 <a name="id-1.3.19.17.3.6.4.4"></a><h2>Description</h2>
  93 <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 runs out of nodes </p>
  94 <div class="refsect2">
  95 <a name="id-1.3.19.17.3.6.4.4.3"></a><h3>
  96 <a name="boost.interprocess.node_allocatorconstruct-copy-destruct"></a><code class="computeroutput">node_allocator</code>
  97         public
  98        construct/copy/destruct</h3>
  99 <div class="orderedlist"><ol class="orderedlist" type="1">
 100 <li class="listitem">
 101 <pre class="literallayout"><a name="idm45336642607824-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>
 102 <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>
 103 </li>
 104 <li class="listitem">
 105 <pre class="literallayout"><a name="idm45336642604800-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">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
 106 <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>
 107 </li>
 108 <li class="listitem">
 109 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</span><span class="keyword">typename</span> T2<span class="special">&gt;</span>
 110   <a name="idm45336642602144-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">&lt;</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">&gt;</span> <span class="special">&amp;</span> other<span class="special">)</span><span class="special">;</span></pre>
 111 <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>
 112 </li>
 113 <li class="listitem">
 114 <pre class="literallayout"><span class="keyword">template</span><span class="special">&lt;</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">&gt;</span>
 115   <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&amp;</span>
 116   <a name="idm45336642660432-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">&lt;</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">&gt;</span> <span class="special">&amp;</span><span class="special">)</span><span class="special">;</span></pre>
 117 <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>
 118 </li>
 119 <li class="listitem">
 120 <pre class="literallayout"><a name="idm45336642597840-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>
 121 <p>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </p>
 122 </li>
 123 </ol></div>
 124 </div>
 125 <div class="refsect2">
 126 <a name="id-1.3.19.17.3.6.4.4.4"></a><h3>
 127 <a name="idm45336642654992-bb"></a><code class="computeroutput">node_allocator</code> public member functions</h3>
 128 <div class="orderedlist"><ol class="orderedlist" type="1">
 129 <li class="listitem">
 130 <pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idm45336642654432-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>
 131 <p>Returns a pointer to the node pool. Never throws </p>
 132 </li>
 133 <li class="listitem">
 134 <pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idm45336642652864-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>
 135 <p>Returns the segment manager. Never throws </p>
 136 </li>
 137 <li class="listitem">
 138 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45336642651296-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>
 139 <p>Returns the number of elements that could be allocated. Never throws </p>
 140 </li>
 141 <li class="listitem">
 142 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45336642649712-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>
 143 <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>
 144 </li>
 145 <li class="listitem">
 146 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642645984-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> count<span class="special">)</span><span class="special">;</span></pre>
 147 <p>Deallocate allocated memory. Never throws </p>
 148 </li>
 149 <li class="listitem">
 150 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642643312-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 151 <p>Deallocates all free blocks of the pool </p>
 152 </li>
 153 <li class="listitem">
 154 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45336642642016-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>
 155 <p>Returns address of mutable object. Never throws </p>
 156 </li>
 157 <li class="listitem">
 158 <pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idm45336642639760-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>
 159 <p>Returns address of non mutable object. Never throws </p>
 160 </li>
 161 <li class="listitem">
 162 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642637504-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">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre>
 163 <p>Copy construct an object. Throws if T's copy constructor throws </p>
 164 </li>
 165 <li class="listitem">
 166 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642634816-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>
 167 <p>Destroys object. Throws if object's destructor throws </p>
 168 </li>
 169 <li class="listitem">
 170 <pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45336642632832-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>
 171 <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>
 172 </li>
 173 <li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45336642630432-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>
 174                            <span class="identifier">size_type</span> limit_size<span class="special">,</span>
 175                            <span class="identifier">size_type</span> <span class="special">&amp;</span> prefer_in_recvd_out_size<span class="special">,</span>
 176                            <span class="identifier">pointer</span> <span class="special">&amp;</span> reuse<span class="special">)</span><span class="special">;</span></pre></li>
 177 <li class="listitem">
 178 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642626800-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>
 179                    <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
 180 <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>
 181 </li>
 182 <li class="listitem">
 183 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642623168-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>
 184                    <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
 185 <p>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </p>
 186 </li>
 187 <li class="listitem">
 188 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642619728-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>
 189 <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>
 190 </li>
 191 <li class="listitem">
 192 <pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45336642617472-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>
 193 <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>
 194 </li>
 195 <li class="listitem">
 196 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642615344-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">,</span>
 197                          <span class="identifier">multiallocation_chain</span> <span class="special">&amp;</span> chain<span class="special">)</span><span class="special">;</span></pre>
 198 <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>
 199 </li>
 200 <li class="listitem">
 201 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642612384-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>
 202 <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>
 203 </li>
 204 <li class="listitem">
 205 <pre class="literallayout"><span class="keyword">void</span> <a name="idm45336642610256-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>
 206 <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>
 207 </li>
 208 </ol></div>
 209 </div>
 210 <div class="refsect2">
 211 <a name="id-1.3.19.17.3.6.4.4.5"></a><h3>
 212 <a name="idm45336642597056-bb"></a><code class="computeroutput">node_allocator</code> friend functions</h3>
 213 <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem">
 214 <pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idm45336642596496-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>
 215 <p>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </p>
 216 </li></ol></div>
 217 </div>
 218 </div>
 219 </div>
 220 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 221 <td align="left"></td>
 222 <td align="right"><div class="copyright-footer">Copyright &#169; 2005-2015 Ion Gaztanaga<p>
 223         Distributed under the Boost Software License, Version 1.0. (See accompanying
 224         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>)
 225       </p>
 226 </div></td>
 227 </tr></table>
 228 <hr>
 229 <div class="spirit-nav">
 230 <a accesskey="p" href="operator_idm45336642686800.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_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>
 231 </div>
 232 </body>
 233 </html>