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=UTF-8"> 5<title>Class template cached_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.cached_node_allocator_hpp" title="Header <boost/interprocess/allocators/cached_node_allocator.hpp>"> 10<link rel="prev" href="operator_idm45304012570288.html" title="Function template operator!="> 11<link rel="next" href="cached_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_idm45304012570288.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_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="cached_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.cached_node_allocator"></a><div class="titlepage"></div> 28<div class="refnamediv"> 29<h2><span class="refentrytitle">Class template cached_node_allocator</span></h2> 30<p>boost::interprocess::cached_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: <<a class="link" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_node_allocator_hpp" title="Header <boost/interprocess/allocators/cached_node_allocator.hpp>">boost/interprocess/allocators/cached_node_allocator.hpp</a>> 34 35</span><span class="keyword">template</span><span class="special"><</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">></span> 36<span class="keyword">class</span> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_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.cached_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.cached_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.cached_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.cached_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.cached_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.cached_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.cached_node_allocator.const_reference"></a><span class="identifier">const_reference</span><span class="special">;</span> 46 <span class="keyword">typedef</span> <span class="identifier">SegmentManager</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.cached_node_allocator.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> 47 <span class="keyword">typedef</span> <span class="identifier">SegmentManager</span><span class="special">::</span><span class="identifier">difference_type</span> <a name="boost.interprocess.cached_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"><</span><span class="keyword">typename</span> T2<span class="special">></span> 51 <span class="keyword">struct</span> <a class="link" href="cached_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="cached_node_allocator.html" title="Class template cached_node_allocator">cached_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> <a class="link" href="cached_node_allocator/rebind.html#boost.interprocess.cached_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="cached_node_allocator.html#boost.interprocess.cached_node_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span> 57 <a class="link" href="cached_node_allocator.html#idm45304012485008-bb"><span class="identifier">cached_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="cached_node_allocator.html#idm45304012482736-bb"><span class="identifier">cached_node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 59 <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> 60 <a class="link" href="cached_node_allocator.html#idm45304012480064-bb"><span class="identifier">cached_node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_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> 61 <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> 62 <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> <span class="special">&</span> 63 <a class="link" href="cached_node_allocator.html#idm45304012543760-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_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> 64 <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> <span class="special">&</span> <a class="link" href="cached_node_allocator.html#idm45304012538304-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 65 <a class="link" href="cached_node_allocator.html#idm45304012475744-bb"><span class="special">~</span><span class="identifier">cached_node_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 66 67 <span class="comment">// <a class="link" href="cached_node_allocator.html#idm45304012535120-bb">public member functions</a></span> 68 <span class="identifier">node_pool_t</span> <span class="special">*</span> <a class="link" href="cached_node_allocator.html#idm45304012534560-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> 69 <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="cached_node_allocator.html#idm45304012532992-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> 70 <span class="identifier">size_type</span> <a class="link" href="cached_node_allocator.html#idm45304012531424-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> 71 <span class="identifier">pointer</span> <a class="link" href="cached_node_allocator.html#idm45304012529840-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> 72 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012526112-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> 73 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012523440-bb"><span class="identifier">deallocate_free_blocks</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 74 <span class="identifier">pointer</span> <a class="link" href="cached_node_allocator.html#idm45304012522144-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> 75 <span class="identifier">const_pointer</span> <a class="link" href="cached_node_allocator.html#idm45304012519888-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> 76 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012517632-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> 77 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012514944-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> 78 <span class="identifier">size_type</span> <a class="link" href="cached_node_allocator.html#idm45304012512960-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> 79 <span class="identifier">pointer</span> <a class="link" href="cached_node_allocator.html#idm45304012510560-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> 80 <span class="identifier">size_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> 81 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012506928-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">&</span><span class="special">)</span><span class="special">;</span> 82 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012503296-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">&</span><span class="special">)</span><span class="special">;</span> 83 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012499856-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="special">;</span> 84 <span class="identifier">pointer</span> <a class="link" href="cached_node_allocator.html#idm45304012497600-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> 85 <span class="identifier">multiallocation_chain</span> <a class="link" href="cached_node_allocator.html#idm45304012495472-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> 86 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012493200-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> 87 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012491072-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> 88 <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012488800-bb"><span class="identifier">set_max_cached_nodes</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> 89 <span class="identifier">size_type</span> <a class="link" href="cached_node_allocator.html#idm45304012486736-bb"><span class="identifier">get_max_cached_nodes</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> 90 91 <span class="comment">// <a class="link" href="cached_node_allocator.html#idm45304012474960-bb">friend functions</a></span> 92 <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idm45304012474400-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> 93<span class="special">}</span><span class="special">;</span></pre></div> 94<div class="refsect1"> 95<a name="id-1.3.19.17.3.5.4.4"></a><h2>Description</h2> 96<div class="refsect2"> 97<a name="id-1.3.19.17.3.5.4.4.2"></a><h3> 98<a name="boost.interprocess.cached_node_allocatorconstruct-copy-destruct"></a><code class="computeroutput">cached_node_allocator</code> 99 public 100 construct/copy/destruct</h3> 101<div class="orderedlist"><ol class="orderedlist" type="1"> 102<li class="listitem"> 103<pre class="literallayout"><a name="idm45304012485008-bb"></a><span class="identifier">cached_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> 104<p>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> 105</li> 106<li class="listitem"> 107<pre class="literallayout"><a name="idm45304012482736-bb"></a><span class="identifier">cached_node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> 108<p>Copy constructor from other <code class="computeroutput"><a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a></code>. Increments the reference count of the associated node pool. Never throws </p> 109</li> 110<li class="listitem"> 111<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> 112 <a name="idm45304012480064-bb"></a><span class="identifier">cached_node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_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> 113<p>Copy constructor from related <code class="computeroutput"><a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_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> 114</li> 115<li class="listitem"> 116<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> 117 <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> <span class="special">&</span> 118 <a name="idm45304012543760-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_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> 119<p>Not assignable from related <code class="computeroutput"><a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a></code> </p> 120</li> 121<li class="listitem"> 122<pre class="literallayout"><a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> <span class="special">&</span> <a name="idm45304012538304-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> 123<p>Not assignable from other <code class="computeroutput"><a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a></code> </p> 124</li> 125<li class="listitem"> 126<pre class="literallayout"><a name="idm45304012475744-bb"></a><span class="special">~</span><span class="identifier">cached_node_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 127<p>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </p> 128</li> 129</ol></div> 130</div> 131<div class="refsect2"> 132<a name="id-1.3.19.17.3.5.4.4.3"></a><h3> 133<a name="idm45304012535120-bb"></a><code class="computeroutput">cached_node_allocator</code> public member functions</h3> 134<div class="orderedlist"><ol class="orderedlist" type="1"> 135<li class="listitem"> 136<pre class="literallayout"><span class="identifier">node_pool_t</span> <span class="special">*</span> <a name="idm45304012534560-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> 137<p>Returns a pointer to the node pool. Never throws </p> 138</li> 139<li class="listitem"> 140<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idm45304012532992-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> 141<p>Returns the segment manager. Never throws </p> 142</li> 143<li class="listitem"> 144<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45304012531424-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> 145<p>Returns the number of elements that could be allocated. Never throws </p> 146</li> 147<li class="listitem"> 148<pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45304012529840-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> 149<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> 150</li> 151<li class="listitem"> 152<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012526112-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> 153<p>Deallocate allocated memory. Never throws </p> 154</li> 155<li class="listitem"> 156<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012523440-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 157<p>Deallocates all free blocks of the pool </p> 158</li> 159<li class="listitem"> 160<pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45304012522144-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> 161<p>Returns address of mutable object. Never throws </p> 162</li> 163<li class="listitem"> 164<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idm45304012519888-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> 165<p>Returns address of non mutable object. Never throws </p> 166</li> 167<li class="listitem"> 168<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012517632-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> 169<p>Default construct an object. Throws if T's default constructor throws </p> 170</li> 171<li class="listitem"> 172<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012514944-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> 173<p>Destroys object. Throws if object's destructor throws </p> 174</li> 175<li class="listitem"> 176<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45304012512960-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> 177<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> 178</li> 179<li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45304012510560-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> 180 <span class="identifier">size_type</span> limit_size<span class="special">,</span> 181 <span class="identifier">size_type</span> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> 182 <span class="identifier">pointer</span> <span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> 183<li class="listitem"> 184<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012506928-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> 185 <span class="identifier">multiallocation_chain</span> <span class="special">&</span> chain<span class="special">)</span><span class="special">;</span></pre> 186<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> 187</li> 188<li class="listitem"> 189<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012503296-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> 190 <span class="identifier">multiallocation_chain</span> <span class="special">&</span> chain<span class="special">)</span><span class="special">;</span></pre> 191<p>Allocates n_elements elements, each one of size elem_sizes[i]in a contiguous block of memory. The elements must be deallocated </p> 192</li> 193<li class="listitem"> 194<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012499856-bb"></a><span class="identifier">deallocate_many</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> <span class="special">&</span> chain<span class="special">)</span><span class="special">;</span></pre> 195<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> 196</li> 197<li class="listitem"> 198<pre class="literallayout"><span class="identifier">pointer</span> <a name="idm45304012497600-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> 199<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> 200</li> 201<li class="listitem"> 202<pre class="literallayout"><span class="identifier">multiallocation_chain</span> <a name="idm45304012495472-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> 203<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> 204</li> 205<li class="listitem"> 206<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012493200-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> 207<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> 208</li> 209<li class="listitem"> 210<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012491072-bb"></a><span class="identifier">deallocate_individual</span><span class="special">(</span><span class="identifier">multiallocation_chain</span> it<span class="special">)</span><span class="special">;</span></pre> 211<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> 212</li> 213<li class="listitem"> 214<pre class="literallayout"><span class="keyword">void</span> <a name="idm45304012488800-bb"></a><span class="identifier">set_max_cached_nodes</span><span class="special">(</span><span class="identifier">size_type</span> newmax<span class="special">)</span><span class="special">;</span></pre> 215<p>Sets the new max cached nodes value. This can provoke deallocations if "newmax" is less than current cached nodes. Never throws </p> 216</li> 217<li class="listitem"> 218<pre class="literallayout"><span class="identifier">size_type</span> <a name="idm45304012486736-bb"></a><span class="identifier">get_max_cached_nodes</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> 219<p>Returns the max cached nodes parameter. Never throws </p> 220</li> 221</ol></div> 222</div> 223<div class="refsect2"> 224<a name="id-1.3.19.17.3.5.4.4.4"></a><h3> 225<a name="idm45304012474960-bb"></a><code class="computeroutput">cached_node_allocator</code> friend functions</h3> 226<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> 227<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idm45304012474400-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> 228<p>Swaps allocators. Does not throw. If each allocator is placed in a different memory segment, the result is undefined. </p> 229</li></ol></div> 230</div> 231</div> 232</div> 233<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 234<td align="left"></td> 235<td align="right"><div class="copyright-footer">Copyright © 2005-2015 Ion Gaztanaga<p> 236 Distributed under the Boost Software License, Version 1.0. (See accompanying 237 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>) 238 </p> 239</div></td> 240</tr></table> 241<hr> 242<div class="spirit-nav"> 243<a accesskey="p" href="operator_idm45304012570288.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_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="cached_node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> 244</div> 245</body> 246</html> 247
