| <html> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> |
| <title>Class template cached_node_allocator</title> |
| <link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css"> |
| <meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| <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.cached_node_allocator_hpp" title="Header <boost/interprocess/allocators/cached_node_allocator.hpp>"> |
| <link rel="prev" href="operator___id813349.html" title="Function template operator!="> |
| <link rel="next" href="cached_node_allocator/rebind.html" title="Struct template rebind"> |
| </head> |
| <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| <table cellpadding="2" width="100%"><tr> |
| <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td> |
| <td align="center"><a href="../../../../index.html">Home</a></td> |
| <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td> |
| <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> |
| <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> |
| <td align="center"><a href="../../../../more/index.htm">More</a></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="operator___id813349.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_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> |
| </div> |
| <div class="refentry"> |
| <a name="boost.interprocess.cached_node_allocator"></a><div class="titlepage"></div> |
| <div class="refnamediv"> |
| <h2><span class="refentrytitle">Class template cached_node_allocator</span></h2> |
| <p>boost::interprocess::cached_node_allocator</p> |
| </div> |
| <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2> |
| <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv"><pre class="synopsis"><span class="comment">// In header: <<a class="link" href="../../boost_interprocess_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>> |
| |
| </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> |
| <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> |
| <span class="keyword">public</span><span class="special">:</span> |
| <span class="comment">// types</span> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <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> |
| <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="boost.interprocess.cached_node_allocator.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> |
| <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ptrdiff_t</span> <a name="boost.interprocess.cached_node_allocator.difference_type"></a><span class="identifier">difference_type</span><span class="special">;</span> |
| |
| <span class="comment">// member classes/structs/unions</span> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> |
| <span class="keyword">struct</span> <a class="link" href="cached_node_allocator/rebind.html" title="Struct template rebind">rebind</a> <span class="special">{</span> |
| <span class="comment">// types</span> |
| <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> |
| <span class="special">}</span><span class="special">;</span> |
| |
| <span class="comment">// <a class="link" href="cached_node_allocator.html#boost.interprocess.cached_node_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span> |
| <a class="link" href="cached_node_allocator.html#id814002-bb"><span class="identifier">cached_node_allocator</span></a><span class="special">(</span><a class="link" href="cached_node_allocator.html#boost.interprocess.cached_node_allocator.segment_manager">segment_manager</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> |
| <a class="link" href="cached_node_allocator.html#id814017-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> |
| <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> |
| <a class="link" href="cached_node_allocator.html#id814033-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> |
| <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> |
| cached_node_allocator& |
| <a class="link" href="cached_node_allocator.html#id813528-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> |
| cached_node_allocator& <a class="link" href="cached_node_allocator.html#id813562-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> |
| <a class="link" href="cached_node_allocator.html#id814058-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> |
| |
| <span class="comment">// <a class="link" href="cached_node_allocator.html#id813577-bb">public member functions</a></span> |
| <span class="identifier">node_pool_t</span> <span class="special">*</span> <a class="link" href="cached_node_allocator.html#id813580-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> |
| <a class="link" href="cached_node_allocator.html#boost.interprocess.cached_node_allocator.segment_manager">segment_manager</a> <span class="special">*</span> <a class="link" href="cached_node_allocator.html#id813592-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="cached_node_allocator.html#id813607-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="cached_node_allocator.html#id813619-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="cached_node_allocator.html#id813646-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="cached_node_allocator.html#id813669-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="cached_node_allocator.html#id813681-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="cached_node_allocator.html#id813698-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="cached_node_allocator.html#id813716-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="cached_node_allocator.html#id813739-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="cached_node_allocator.html#id813757-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="cached_node_allocator.html#id813777-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="cached_node_allocator.html#id813816-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">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> |
| <span class="identifier">multiallocation_chain</span> <a class="link" href="cached_node_allocator.html#id813844-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="cached_node_allocator.html#id813868-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="cached_node_allocator.html#id813890-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="cached_node_allocator.html#id813905-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> |
| <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#id813928-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="cached_node_allocator.html#id813948-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="keyword">void</span> <a class="link" href="cached_node_allocator.html#id813970-bb"><span class="identifier">set_max_cached_nodes</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">)</span><span class="special">;</span> |
| <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="cached_node_allocator.html#id813990-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> |
| |
| <span class="comment">// <a class="link" href="cached_node_allocator.html#id814064-bb">friend functions</a></span> |
| <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#id814068-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="id1434532"></a><h2>Description</h2> |
| <div class="refsect2"> |
| <a name="id1434536"></a><h3> |
| <a name="boost.interprocess.cached_node_allocatorconstruct-copy-destruct"></a><code class="computeroutput">cached_node_allocator</code> |
| public |
| construct/copy/destruct</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><a name="id814002-bb"></a><span class="identifier">cached_node_allocator</span><span class="special">(</span><a class="link" href="cached_node_allocator.html#boost.interprocess.cached_node_allocator.segment_manager">segment_manager</a> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> |
| <p>Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw boost::interprocess::bad_alloc </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><a name="id814017-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> |
| <p>Copy constructor from other cached_node_allocator. 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="id814033-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> |
| <p>Copy constructor from related cached_node_allocator. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw boost::interprocess::bad_alloc </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> |
| cached_node_allocator& |
| <a name="id813528-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> |
| <p>Not assignable from related cached_node_allocator </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout">cached_node_allocator& <a name="id813562-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> |
| <p>Not assignable from other cached_node_allocator </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><a name="id814058-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> |
| <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="id1435005"></a><h3> |
| <a name="id813577-bb"></a><code class="computeroutput">cached_node_allocator</code> public member functions</h3> |
| <div class="orderedlist"><ol class="orderedlist" type="1"> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">node_pool_t</span> <span class="special">*</span> <a name="id813580-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"><a class="link" href="cached_node_allocator.html#boost.interprocess.cached_node_allocator.segment_manager">segment_manager</a> <span class="special">*</span> <a name="id813592-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="id813607-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="id813619-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 boost::interprocess::bad_alloc if there is no enough memory </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">void</span> <a name="id813646-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="id813669-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="id813681-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="id813698-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="id813716-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>Default construct an object. Throws if T's default constructor throws </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="keyword">void</span> <a name="id813739-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="id813757-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="id813777-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="id813816-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">std</span><span class="special">::</span><span class="identifier">size_t</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="id813844-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="id813868-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="id813890-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 boost::interprocess::bad_alloc if there is no enough memory </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">multiallocation_chain</span> <a name="id813905-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</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="id813928-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="id813948-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> |
| <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="id813970-bb"></a><span class="identifier">set_max_cached_nodes</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> newmax<span class="special">)</span><span class="special">;</span></pre> |
| <p>Sets the new max cached nodes value. This can provoke deallocations if "newmax" is less than current cached nodes. Never throws </p> |
| </li> |
| <li class="listitem"> |
| <pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="id813990-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> |
| <p>Returns the max cached nodes parameter. Never throws </p> |
| </li> |
| </ol></div> |
| </div> |
| <div class="refsect2"> |
| <a name="id1436280"></a><h3> |
| <a name="id814064-bb"></a><code class="computeroutput">cached_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="id814068-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> |
| </div> |
| </div> |
| <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> |
| <td align="left"></td> |
| <td align="right"><div class="copyright-footer">Copyright © 2005 - 2010 Ion Gaztanaga<p> |
| Distributed under the Boost Software License, Version 1.0. (See accompanying |
| file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) |
| </p> |
| </div></td> |
| </tr></table> |
| <hr> |
| <div class="spirit-nav"> |
| <a accesskey="p" href="operator___id813349.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../boost_interprocess_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> |
| </div> |
| </body> |
| </html> |