diff options
Diffstat (limited to 'doc/html/boost/interprocess')
145 files changed, 2473 insertions, 2473 deletions
diff --git a/doc/html/boost/interprocess/accept_ownership.html b/doc/html/boost/interprocess/accept_ownership.html index 92445d2f1f..fddc926f6f 100644 --- a/doc/html/boost/interprocess/accept_ownership.html +++ b/doc/html/boost/interprocess/accept_ownership.html @@ -34,7 +34,7 @@ </span><span class="keyword">static</span> <span class="keyword">const</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a> accept_ownership<span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp265788432"></a><h2>Description</h2> +<a name="idp284641424"></a><h2>Description</h2> <p>An object indicating that the ownership of lockable object must be accepted by the new owner. </p> </div> </div> diff --git a/doc/html/boost/interprocess/adaptive_pool.html b/doc/html/boost/interprocess/adaptive_pool.html index ff699aaa1b..4326c3ce5b 100644 --- a/doc/html/boost/interprocess/adaptive_pool.html +++ b/doc/html/boost/interprocess/adaptive_pool.html @@ -55,158 +55,158 @@ <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="adaptive_pool.html#boost.interprocess.adaptive_poolconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="adaptive_pool.html#idp61613552-bb"><span class="identifier">adaptive_pool</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="adaptive_pool.html#idp61616576-bb"><span class="identifier">adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="adaptive_pool.html#idp54498144-bb"><span class="identifier">adaptive_pool</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="adaptive_pool.html#idp54501168-bb"><span class="identifier">adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="adaptive_pool.html#idp61619104-bb"><span class="identifier">adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="adaptive_pool.html#idp54503728-bb"><span class="identifier">adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</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> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> F2<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> OP2<span class="special">></span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a> <span class="special">&</span> - <a class="link" href="adaptive_pool.html#idp61233184-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="identifier">F2</span><span class="special">,</span> <span class="identifier">OP2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="adaptive_pool.html#idp61623280-bb"><span class="special">~</span><span class="identifier">adaptive_pool</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="adaptive_pool.html#idp54117776-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="identifier">F2</span><span class="special">,</span> <span class="identifier">OP2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="adaptive_pool.html#idp54508064-bb"><span class="special">~</span><span class="identifier">adaptive_pool</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="adaptive_pool.html#idp39144560-bb">public member functions</a></span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="adaptive_pool.html#idp39145120-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="adaptive_pool.html#idp39146624-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="adaptive_pool.html#idp39148128-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="adaptive_pool.html#idp39149712-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="adaptive_pool.html#idp39153376-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="adaptive_pool.html#idp39155984-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="adaptive_pool.html#idp39157216-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="adaptive_pool.html#idp39159472-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="identifier">size_type</span> <a class="link" href="adaptive_pool.html#idp39161728-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">pointer</span> <a class="link" href="adaptive_pool.html#idp39164128-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="comment">// <a class="link" href="adaptive_pool.html#idp32016848-bb">public member functions</a></span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="adaptive_pool.html#idp32017408-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="adaptive_pool.html#idp32018912-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="adaptive_pool.html#idp32020416-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="adaptive_pool.html#idp32022000-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="adaptive_pool.html#idp32025664-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="adaptive_pool.html#idp32028272-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="adaptive_pool.html#idp32029504-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="adaptive_pool.html#idp32031760-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="identifier">size_type</span> <a class="link" href="adaptive_pool.html#idp32034016-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">pointer</span> <a class="link" href="adaptive_pool.html#idp32036416-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="special">,</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="adaptive_pool.html#idp61594576-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> - <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp61598208-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> - <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp61601648-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> - <span class="identifier">pointer</span> <a class="link" href="adaptive_pool.html#idp61603904-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp61606032-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">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp61608992-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="adaptive_pool.html#idp61611120-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="special">;</span> + <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp54479168-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> + <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp54482800-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> + <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp54486240-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> + <span class="identifier">pointer</span> <a class="link" href="adaptive_pool.html#idp54488496-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp54490624-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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp54493584-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="adaptive_pool.html#idp54495712-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="special">;</span> - <span class="comment">// <a class="link" href="adaptive_pool.html#idp61624064-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp61624624-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="adaptive_pool.html#idp54508848-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="adaptive_pool.html#idp54509408-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="idp250481248"></a><h2>Description</h2> +<a name="idp269331840"></a><h2>Description</h2> <p>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc...</p> <p>This node allocator shares a segregated storage between all instances of <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a> with equal sizeof(T) placed in the same segment group. NodesPerBlock is the number of nodes allocated at once when the allocator needs runs out of nodes. MaxFreeBlocks is the maximum number of totally free blocks that the adaptive node pool will hold. The rest of the totally free blocks will be deallocated with the segment manager.</p> <p>OverheadPercent is the (approximated) maximum size overhead (1-20%) of the allocator: (memory usable for nodes / total memory allocated from the segment manager) </p> <div class="refsect2"> -<a name="idp250484208"></a><h3> +<a name="idp269334800"></a><h3> <a name="boost.interprocess.adaptive_poolconstruct-copy-destruct"></a><code class="computeroutput">adaptive_pool</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp61613552-bb"></a><span class="identifier">adaptive_pool</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54498144-bb"></a><span class="identifier">adaptive_pool</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from other <code class="computeroutput"><a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a></code> Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp61616576-bb"></a><span class="identifier">adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54501168-bb"></a><span class="identifier">adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from other <code class="computeroutput"><a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a></code>. Increments the reference count of the associated node pool. Never throws </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> - <a name="idp61619104-bb"></a><span class="identifier">adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> + <a name="idp54503728-bb"></a><span class="identifier">adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from related <code class="computeroutput"><a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a></code>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> SegmentManager2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> F2<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> OP2<span class="special">></span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a> <span class="special">&</span> - <a name="idp61233184-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="identifier">F2</span><span class="special">,</span> <span class="identifier">OP2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp54117776-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="identifier">F2</span><span class="special">,</span> <span class="identifier">OP2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from related <code class="computeroutput"><a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp61623280-bb"></a><span class="special">~</span><span class="identifier">adaptive_pool</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54508064-bb"></a><span class="special">~</span><span class="identifier">adaptive_pool</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="idp250551184"></a><h3> -<a name="idp39144560-bb"></a><code class="computeroutput">adaptive_pool</code> public member functions</h3> +<a name="idp269401584"></a><h3> +<a name="idp32016848-bb"></a><code class="computeroutput">adaptive_pool</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp39145120-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp32017408-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a pointer to the node pool. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp39146624-bb"></a><span class="identifier">get_segment_manager</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp32018912-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="idp39148128-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp32020416-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="idp39149712-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp32022000-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocate memory for an array of count elements. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp39153376-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp32025664-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="idp39155984-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp32028272-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="idp39157216-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp32029504-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="idp39159472-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">const_reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idp32031760-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="identifier">size_type</span> <a name="idp39161728-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp32034016-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">pointer</span> <a name="idp39164128-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> +<li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp32036416-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> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">pointer</span> <span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61594576-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54479168-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">size_type</span> num_elements<span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&</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="keyword">void</span> <a name="idp61598208-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54482800-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<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="idp61601648-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54486240-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> <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="idp61603904-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54488496-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61606032-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54490624-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<span class="special">)</span><span class="special">;</span></pre> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61608992-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54493584-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="idp61611120-bb"></a><span class="identifier">deallocate_individual</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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54495712-bb"></a><span class="identifier">deallocate_individual</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> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp250677264"></a><h3> -<a name="idp61624064-bb"></a><code class="computeroutput">adaptive_pool</code> friend functions</h3> +<a name="idp269527600"></a><h3> +<a name="idp54508848-bb"></a><code class="computeroutput">adaptive_pool</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="idp61624624-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp54509408-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> diff --git a/doc/html/boost/interprocess/adaptive_pool/rebind.html b/doc/html/boost/interprocess/adaptive_pool/rebind.html index 3f4a8bca9d..3c15060506 100644 --- a/doc/html/boost/interprocess/adaptive_pool/rebind.html +++ b/doc/html/boost/interprocess/adaptive_pool/rebind.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../adaptive_pool.html#idp250481248" title="Description"> +<link rel="up" href="../adaptive_pool.html#idp269331840" title="Description"> <link rel="prev" href="../adaptive_pool.html" title="Class template adaptive_pool"> -<link rel="next" href="../operator___idp61627680.html" title="Function template operator=="> +<link rel="next" href="../operator___idp54512464.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptive_pool.html#idp250481248"><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="../operator___idp61627680.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptive_pool.html#idp269331840"><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="../operator___idp54512464.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.adaptive_pool.rebind"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <span class="keyword">typedef</span> <a class="link" href="../adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <a name="boost.interprocess.adaptive_pool.rebind.other"></a><span class="identifier">other</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp250708736"></a><h2>Description</h2> +<a name="idp269559136"></a><h2>Description</h2> <p>Obtains <a class="link" href="../adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a> from <a class="link" href="../adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a> </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptive_pool.html#idp250481248"><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="../operator___idp61627680.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../adaptive_pool.html#idp269331840"><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="../operator___idp54512464.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/allocator.html b/doc/html/boost/interprocess/allocator.html index a17c42abc4..57cd7c9e55 100644 --- a/doc/html/boost/interprocess/allocator.html +++ b/doc/html/boost/interprocess/allocator.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp" title="Header <boost/interprocess/allocators/allocator.hpp>"> -<link rel="prev" href="operator___idp61635952.html" title="Function template operator!="> +<link rel="prev" href="operator___idp54520736.html" title="Function template operator!="> <link rel="next" href="allocator/rebind.html" title="Struct template rebind"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61635952.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54520736.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.allocator"></a><div class="titlepage"></div> @@ -55,138 +55,138 @@ <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="allocator.html#boost.interprocess.allocatorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="allocator.html#idp61706736-bb"><span class="identifier">allocator</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="allocator.html#idp61708160-bb"><span class="identifier">allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a> <span class="special">&</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="allocator.html#idp61710032-bb"><span class="identifier">allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="allocator.html#idp54591328-bb"><span class="identifier">allocator</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="allocator.html#idp54592752-bb"><span class="identifier">allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a> <span class="special">&</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="allocator.html#idp54594624-bb"><span class="identifier">allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="allocator.html#idp61661504-bb">public member functions</a></span> - <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="allocator.html#idp61662064-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">pointer</span> <a class="link" href="allocator.html#idp61663632-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">cvoid_ptr</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="allocator.html#idp61667376-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="identifier">size_type</span> <a class="link" href="allocator.html#idp61670048-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">size_type</span> <a class="link" href="allocator.html#idp61671632-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">pointer</span> <a class="link" href="allocator.html#idp61674032-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="comment">// <a class="link" href="allocator.html#idp54546096-bb">public member functions</a></span> + <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="allocator.html#idp54546656-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">pointer</span> <a class="link" href="allocator.html#idp54548224-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">cvoid_ptr</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="allocator.html#idp54551968-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="identifier">size_type</span> <a class="link" href="allocator.html#idp54554640-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">size_type</span> <a class="link" href="allocator.html#idp54556224-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">pointer</span> <a class="link" href="allocator.html#idp54558624-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="special">,</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="allocator.html#idp61677664-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> - <span class="keyword">void</span> <a class="link" href="allocator.html#idp61681296-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> - <span class="keyword">void</span> <a class="link" href="allocator.html#idp61684736-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> - <span class="identifier">pointer</span> <a class="link" href="allocator.html#idp61686992-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="allocator.html#idp61689120-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">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="allocator.html#idp61692080-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="allocator.html#idp61694208-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="special">;</span> - <span class="identifier">pointer</span> <a class="link" href="allocator.html#idp61696480-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="allocator.html#idp61698736-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">template</span><span class="special"><</span><span class="keyword">typename</span> P<span class="special">></span> <span class="keyword">void</span> <a class="link" href="allocator.html#idp61700992-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">P</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="allocator.html#idp61704592-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="keyword">void</span> <a class="link" href="allocator.html#idp54562256-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> + <span class="keyword">void</span> <a class="link" href="allocator.html#idp54565888-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> + <span class="keyword">void</span> <a class="link" href="allocator.html#idp54569328-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> + <span class="identifier">pointer</span> <a class="link" href="allocator.html#idp54571584-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="allocator.html#idp54573712-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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="allocator.html#idp54576672-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="allocator.html#idp54578800-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="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="allocator.html#idp54581072-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="allocator.html#idp54583328-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">template</span><span class="special"><</span><span class="keyword">typename</span> P<span class="special">></span> <span class="keyword">void</span> <a class="link" href="allocator.html#idp54585584-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">P</span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="allocator.html#idp54589184-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="comment">// <a class="link" href="allocator.html#idp61712768-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="allocator.html#idp61713328-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="allocator.html#idp54597360-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="allocator.html#idp54597920-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="idp251064896"></a><h2>Description</h2> +<a name="idp269915664"></a><h2>Description</h2> <p>An STL compatible allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc... </p> <div class="refsect2"> -<a name="idp251065856"></a><h3> +<a name="idp269916624"></a><h3> <a name="boost.interprocess.allocatorconstruct-copy-destruct"></a><code class="computeroutput">allocator</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp61706736-bb"></a><span class="identifier">allocator</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54591328-bb"></a><span class="identifier">allocator</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> <p>Constructor from the segment manager. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp61708160-bb"></a><span class="identifier">allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54592752-bb"></a><span class="identifier">allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Constructor from other allocator. 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="idp61710032-bb"></a><span class="identifier">allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> <a name="idp54594624-bb"></a><span class="identifier">allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Constructor from related allocator. Never throws </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp251091344"></a><h3> -<a name="idp61661504-bb"></a><code class="computeroutput">allocator</code> public member functions</h3> +<a name="idp269942176"></a><h3> +<a name="idp54546096-bb"></a><code class="computeroutput">allocator</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp61662064-bb"></a><span class="identifier">get_segment_manager</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp54546656-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">pointer</span> <a name="idp61663632-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_ptr</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54548224-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_ptr</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates memory for an array of count elements. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61667376-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><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54551968-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><span class="special">)</span><span class="special">;</span></pre> <p>Deallocates memory previously allocated. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp61670048-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54554640-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">size_type</span> <a name="idp61671632-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54556224-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">pointer</span> <a name="idp61674032-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> +<li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54558624-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> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">pointer</span> <span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61677664-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54562256-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">size_type</span> num_elements<span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&</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="keyword">void</span> <a name="idp61681296-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54565888-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<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="idp61684736-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54569328-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> <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="idp61686992-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54571584-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61689120-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54573712-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<span class="special">)</span><span class="special">;</span></pre> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61692080-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54576672-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="idp61694208-bb"></a><span class="identifier">deallocate_individual</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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54578800-bb"></a><span class="identifier">deallocate_individual</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> <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="identifier">pointer</span> <a name="idp61696480-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54581072-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="idp61698736-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">const_reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idp54583328-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">template</span><span class="special"><</span><span class="keyword">typename</span> P<span class="special">></span> <span class="keyword">void</span> <a name="idp61700992-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">P</span> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> P<span class="special">></span> <span class="keyword">void</span> <a name="idp54585584-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">P</span> <span class="special">&&</span> p<span class="special">)</span><span class="special">;</span></pre> <p>Constructs an object Throws if T's constructor throws For backwards compatibility with libraries using C++03 allocators </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61704592-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54589184-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> </ol></div> </div> <div class="refsect2"> -<a name="idp251224128"></a><h3> -<a name="idp61712768-bb"></a><code class="computeroutput">allocator</code> friend functions</h3> +<a name="idp270075216"></a><h3> +<a name="idp54597360-bb"></a><code class="computeroutput">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="idp61713328-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp54597920-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>Swap segment manager. Does not throw. If each allocator is placed in different memory segments, the result is undefined. </p> </li></ol></div> </div> @@ -202,7 +202,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61635952.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54520736.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/allocator/rebind.html b/doc/html/boost/interprocess/allocator/rebind.html index d3d11b0b59..1c93699ab1 100644 --- a/doc/html/boost/interprocess/allocator/rebind.html +++ b/doc/html/boost/interprocess/allocator/rebind.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../allocator.html#idp251064896" title="Description"> +<link rel="up" href="../allocator.html#idp269915664" title="Description"> <link rel="prev" href="../allocator.html" title="Class template allocator"> -<link rel="next" href="../operator___idp61716400.html" title="Function template operator=="> +<link rel="next" href="../operator___idp54600992.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../allocator.html#idp251064896"><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="../operator___idp61716400.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../allocator.html#idp269915664"><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="../operator___idp54600992.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.allocator.rebind"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <span class="keyword">typedef</span> <a class="link" href="../allocator.html" title="Class template allocator">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 name="boost.interprocess.allocator.rebind.other"></a><span class="identifier">other</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp251252016"></a><h2>Description</h2> +<a name="idp270103232"></a><h2>Description</h2> <p>Obtains an allocator that allocates objects of type T2 </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../allocator.html#idp251064896"><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="../operator___idp61716400.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../allocator.html#idp269915664"><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="../operator___idp54600992.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/anonymous_shared_memory.html b/doc/html/boost/interprocess/anonymous_shared_memory.html index 86d37af03a..99f0dcafce 100644 --- a/doc/html/boost/interprocess/anonymous_shared_memory.html +++ b/doc/html/boost/interprocess/anonymous_shared_memory.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.anonymous_shared_memory_hpp" title="Header <boost/interprocess/anonymous_shared_memory.hpp>"> -<link rel="prev" href="operator___idp62249856.html" title="Function template operator!="> +<link rel="prev" href="operator___idp55134448.html" title="Function template operator!="> <link rel="next" href="allocate_new.html" title="Global allocate_new"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62249856.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.anonymous_shared_memory_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="allocate_new.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp55134448.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.anonymous_shared_memory_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="allocate_new.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.anonymous_shared_memory"></a><div class="titlepage"></div> @@ -35,7 +35,7 @@ </span> <a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="identifier">anonymous_shared_memory</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> address <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254523424"></a><h2>Description</h2> +<a name="idp273373696"></a><h2>Description</h2> <p>A function that creates an anonymous shared memory segment of size "size". If "address" is passed the function will try to map the segment in that address. Otherwise the operating system will choose the mapping address. The function returns a <code class="computeroutput"><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a></code> holding that segment or throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if the function fails. </p> </div> </div> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62249856.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.anonymous_shared_memory_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="allocate_new.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp55134448.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.anonymous_shared_memory_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="allocate_new.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/bad_alloc.html b/doc/html/boost/interprocess/bad_alloc.html index f5c2706c0e..5fe7e6957f 100644 --- a/doc/html/boost/interprocess/bad_alloc.html +++ b/doc/html/boost/interprocess/bad_alloc.html @@ -36,25 +36,25 @@ <span class="keyword">class</span> <a class="link" href="bad_alloc.html" title="Class bad_alloc">bad_alloc</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">interprocess</span><span class="special">::</span><span class="identifier">interprocess_exception</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="bad_alloc.html#boost.interprocess.bad_allocconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="bad_alloc.html#idp62355216-bb"><span class="identifier">bad_alloc</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="bad_alloc.html#idp55239808-bb"><span class="identifier">bad_alloc</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="bad_alloc.html#idp62353104-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="bad_alloc.html#idp62353664-bb"><span class="identifier">what</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="bad_alloc.html#idp55237696-bb">public member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="bad_alloc.html#idp55238256-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254905280"></a><h2>Description</h2> +<a name="idp273755728"></a><h2>Description</h2> <p>This exception is thrown when a memory request can't be fulfilled. </p> <div class="refsect2"> -<a name="idp254905952"></a><h3> +<a name="idp273756400"></a><h3> <a name="boost.interprocess.bad_allocconstruct-copy-destruct"></a><code class="computeroutput">bad_alloc</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp62355216-bb"></a><span class="identifier">bad_alloc</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp55239808-bb"></a><span class="identifier">bad_alloc</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp254911824"></a><h3> -<a name="idp62353104-bb"></a><code class="computeroutput">bad_alloc</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp62353664-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> +<a name="idp273762208"></a><h3> +<a name="idp55237696-bb"></a><code class="computeroutput">bad_alloc</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp55238256-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> diff --git a/doc/html/boost/interprocess/basic_bufferbuf.html b/doc/html/boost/interprocess/basic_bufferbuf.html index ed53c22061..250edeb67b 100644 --- a/doc/html/boost/interprocess/basic_bufferbuf.html +++ b/doc/html/boost/interprocess/basic_bufferbuf.html @@ -44,46 +44,46 @@ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_streambuf</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">traits_type</span> <span class="special">></span> <a name="boost.interprocess.basic_bufferbuf.basic_streambuf_t"></a><span class="identifier">basic_streambuf_t</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_bufferbuf.html#boost.interprocess.basic_bufferbufconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="basic_bufferbuf.html#idp63739312-bb"><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="basic_bufferbuf.html#idp63741296-bb"><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="keyword">explicit</span> <a class="link" href="basic_bufferbuf.html#idp56623904-bb"><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="basic_bufferbuf.html#idp56625888-bb"><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_bufferbuf.html#idp63744688-bb"><span class="special">~</span><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_bufferbuf.html#idp56629280-bb"><span class="special">~</span><span class="identifier">basic_bufferbuf</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_bufferbuf.html#idp63734304-bb">public member functions</a></span> - <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="basic_bufferbuf.html#idp63734864-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_bufferbuf.html#idp63736464-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="comment">// <a class="link" href="basic_bufferbuf.html#idp56618896-bb">public member functions</a></span> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="basic_bufferbuf.html#idp56619456-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_bufferbuf.html#idp56621056-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp263078320"></a><h2>Description</h2> +<a name="idp281929440"></a><h2>Description</h2> <p>A streambuf class that controls the transmission of elements to and from a basic_xbufferstream. The elements are transmitted from a to a fixed size buffer </p> <div class="refsect2"> -<a name="idp263079168"></a><h3> +<a name="idp281930288"></a><h3> <a name="boost.interprocess.basic_bufferbufconstruct-copy-destruct"></a><code class="computeroutput">basic_bufferbuf</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp63739312-bb"></a><span class="identifier">basic_bufferbuf</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56623904-bb"></a><span class="identifier">basic_bufferbuf</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp63741296-bb"></a><span class="identifier">basic_bufferbuf</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56625888-bb"></a><span class="identifier">basic_bufferbuf</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Assigns formatting buffer. Does not throw. </p> </li> -<li class="listitem"><pre class="literallayout"><a name="idp63744688-bb"></a><span class="special">~</span><span class="identifier">basic_bufferbuf</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp56629280-bb"></a><span class="special">~</span><span class="identifier">basic_bufferbuf</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp263118096"></a><h3> -<a name="idp63734304-bb"></a><code class="computeroutput">basic_bufferbuf</code> public member functions</h3> +<a name="idp281969184"></a><h3> +<a name="idp56618896-bb"></a><code class="computeroutput">basic_bufferbuf</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <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">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="idp63734864-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="idp56619456-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the pointer and size of the internal buffer. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63736464-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56621056-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre> <p>Sets the underlying buffer to a new value Does not throw. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/basic_bufferstream.html b/doc/html/boost/interprocess/basic_bufferstream.html index e514e8bde9..f49974b581 100644 --- a/doc/html/boost/interprocess/basic_bufferstream.html +++ b/doc/html/boost/interprocess/basic_bufferstream.html @@ -43,51 +43,51 @@ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">traits_type</span> <a name="boost.interprocess.basic_bufferstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_bufferstream.html#boost.interprocess.basic_bufferstreamconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_bufferstream.html#idp63797648-bb"><span class="identifier">basic_bufferstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_bufferstream.html#idp63799360-bb"><span class="identifier">basic_bufferstream</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> + <a class="link" href="basic_bufferstream.html#idp56682240-bb"><span class="identifier">basic_bufferstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_bufferstream.html#idp56683952-bb"><span class="identifier">basic_bufferstream</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_bufferstream.html#idp63802480-bb"><span class="special">~</span><span class="identifier">basic_bufferstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_bufferstream.html#idp56687072-bb"><span class="special">~</span><span class="identifier">basic_bufferstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_bufferstream.html#idp63790768-bb">public member functions</a></span> - <a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_bufferstream.html#idp63791328-bb"><span class="identifier">rdbuf</span></a><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">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="basic_bufferstream.html#idp63793184-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_bufferstream.html#idp63794784-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="comment">// <a class="link" href="basic_bufferstream.html#idp56675360-bb">public member functions</a></span> + <a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_bufferstream.html#idp56675920-bb"><span class="identifier">rdbuf</span></a><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">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="basic_bufferstream.html#idp56677776-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_bufferstream.html#idp56679376-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp263624576"></a><h2>Description</h2> +<a name="idp282475936"></a><h2>Description</h2> <p>A basic_iostream class that uses a fixed size character buffer as its formatting buffer. </p> <div class="refsect2"> -<a name="idp263625360"></a><h3> +<a name="idp282476720"></a><h3> <a name="boost.interprocess.basic_bufferstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_bufferstream</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63797648-bb"></a><span class="identifier">basic_bufferstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56682240-bb"></a><span class="identifier">basic_bufferstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63799360-bb"></a><span class="identifier">basic_bufferstream</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span> +<pre class="literallayout"><a name="idp56683952-bb"></a><span class="identifier">basic_bufferstream</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Assigns formatting buffer. Does not throw. </p> </li> -<li class="listitem"><pre class="literallayout"><a name="idp63802480-bb"></a><span class="special">~</span><span class="identifier">basic_bufferstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp56687072-bb"></a><span class="special">~</span><span class="identifier">basic_bufferstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp263662752"></a><h3> -<a name="idp63790768-bb"></a><code class="computeroutput">basic_bufferstream</code> public member functions</h3> +<a name="idp282514240"></a><h3> +<a name="idp56675360-bb"></a><code class="computeroutput">basic_bufferstream</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp63791328-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp56675920-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the address of the stored stream buffer. </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">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="idp63793184-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="idp56677776-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the pointer and size of the internal buffer. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63794784-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56679376-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre> <p>Sets the underlying buffer to a new value. Resets stream position. Does not throw. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/basic_ibufferstream.html b/doc/html/boost/interprocess/basic_ibufferstream.html index dad6913f25..963fcddbac 100644 --- a/doc/html/boost/interprocess/basic_ibufferstream.html +++ b/doc/html/boost/interprocess/basic_ibufferstream.html @@ -43,51 +43,51 @@ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">traits_type</span> <a name="boost.interprocess.basic_ibufferstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_ibufferstream.html#boost.interprocess.basic_ibufferstreamconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_ibufferstream.html#idp63759136-bb"><span class="identifier">basic_ibufferstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_ibufferstream.html#idp63760832-bb"><span class="identifier">basic_ibufferstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> + <a class="link" href="basic_ibufferstream.html#idp56643728-bb"><span class="identifier">basic_ibufferstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ibufferstream.html#idp56645424-bb"><span class="identifier">basic_ibufferstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</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="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_ibufferstream.html#idp63763936-bb"><span class="special">~</span><span class="identifier">basic_ibufferstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ibufferstream.html#idp56648528-bb"><span class="special">~</span><span class="identifier">basic_ibufferstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_ibufferstream.html#idp63752256-bb">public member functions</a></span> - <a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_ibufferstream.html#idp63752816-bb"><span class="identifier">rdbuf</span></a><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="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="basic_ibufferstream.html#idp63754672-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_ibufferstream.html#idp63756272-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</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="comment">// <a class="link" href="basic_ibufferstream.html#idp56636848-bb">public member functions</a></span> + <a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_ibufferstream.html#idp56637408-bb"><span class="identifier">rdbuf</span></a><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="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="basic_ibufferstream.html#idp56639264-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ibufferstream.html#idp56640864-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</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="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp263257968"></a><h2>Description</h2> +<a name="idp282109312"></a><h2>Description</h2> <p>A basic_istream class that uses a fixed size character buffer as its formatting buffer. </p> <div class="refsect2"> -<a name="idp263258752"></a><h3> +<a name="idp282110096"></a><h3> <a name="boost.interprocess.basic_ibufferstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_ibufferstream</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63759136-bb"></a><span class="identifier">basic_ibufferstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56643728-bb"></a><span class="identifier">basic_ibufferstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63760832-bb"></a><span class="identifier">basic_ibufferstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span> +<pre class="literallayout"><a name="idp56645424-bb"></a><span class="identifier">basic_ibufferstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Assigns formatting buffer. Does not throw. </p> </li> -<li class="listitem"><pre class="literallayout"><a name="idp63763936-bb"></a><span class="special">~</span><span class="identifier">basic_ibufferstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp56648528-bb"></a><span class="special">~</span><span class="identifier">basic_ibufferstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp263290496"></a><h3> -<a name="idp63752256-bb"></a><code class="computeroutput">basic_ibufferstream</code> public member functions</h3> +<a name="idp282141840"></a><h3> +<a name="idp56636848-bb"></a><code class="computeroutput">basic_ibufferstream</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp63752816-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp56637408-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the address of the stored stream buffer. </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="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="idp63754672-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="idp56639264-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the pointer and size of the internal buffer. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63756272-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56640864-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre> <p>Sets the underlying buffer to a new value. Resets stream position. Does not throw. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/basic_ivectorstream.html b/doc/html/boost/interprocess/basic_ivectorstream.html index f4dd3e6502..8145ae2035 100644 --- a/doc/html/boost/interprocess/basic_ivectorstream.html +++ b/doc/html/boost/interprocess/basic_ivectorstream.html @@ -46,61 +46,61 @@ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">traits_type</span> <a name="boost.interprocess.basic_ivectorstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_ivectorstream.html#boost.interprocess.basic_ivectorstreamconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_ivectorstream.html#idp63856448-bb"><span class="identifier">basic_ivectorstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ivectorstream.html#idp56741040-bb"><span class="identifier">basic_ivectorstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <a class="link" href="basic_ivectorstream.html#idp63858176-bb"><span class="identifier">basic_ivectorstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> + <a class="link" href="basic_ivectorstream.html#idp56742768-bb"><span class="identifier">basic_ivectorstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_ivectorstream.html#idp63846784-bb">public member functions</a></span> - <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_ivectorstream.html#idp63847344-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_ivectorstream.html#idp63849216-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_ivectorstream.html#idp63851280-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_ivectorstream.html#idp63852864-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</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="basic_ivectorstream.html#idp63854960-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_ivectorstream.html#idp56731376-bb">public member functions</a></span> + <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_ivectorstream.html#idp56731936-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ivectorstream.html#idp56733808-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_ivectorstream.html#idp56735872-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ivectorstream.html#idp56737456-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</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="basic_ivectorstream.html#idp56739552-bb"><span class="identifier">clear</span></a><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="idp264012528"></a><h2>Description</h2> +<a name="idp282864416"></a><h2>Description</h2> <p>A basic_istream class that holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </p> <div class="refsect2"> -<a name="idp264013456"></a><h3> +<a name="idp282865312"></a><h3> <a name="boost.interprocess.basic_ivectorstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_ivectorstream</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63856448-bb"></a><span class="identifier">basic_ivectorstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56741040-bb"></a><span class="identifier">basic_ivectorstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type default constructor throws. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <a name="idp63858176-bb"></a><span class="identifier">basic_ivectorstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> + <a name="idp56742768-bb"></a><span class="identifier">basic_ivectorstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type(const VectorParameter &param) throws. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp264041232"></a><h3> -<a name="idp63846784-bb"></a><code class="computeroutput">basic_ivectorstream</code> public member functions</h3> +<a name="idp282893232"></a><h3> +<a name="idp56731376-bb"></a><code class="computeroutput">basic_ivectorstream</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp63847344-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp56731936-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the address of the stored stream buffer. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63849216-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56733808-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the underlying vector with the passed vector. This function resets the read position in the stream. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp63851280-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp56735872-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a const reference to the internal vector. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63852864-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56737456-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> <p>Calls reserve() method of the internal vector. Resets the stream to the first position. Throws if the internals vector's reserve throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63854960-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56739552-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Calls clear() method of the internal vector. Resets the stream to the first position. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/basic_managed__idp62606272.html b/doc/html/boost/interprocess/basic_managed__idp55490864.html index ef4fbe4554..359e7b5f71 100644 --- a/doc/html/boost/interprocess/basic_managed__idp62606272.html +++ b/doc/html/boost/interprocess/basic_managed__idp55490864.html @@ -24,7 +24,7 @@ <a accesskey="p" href="message_queue.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_external_buffer_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="managed_external_buffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.basic_managed__idp62606272"></a><div class="titlepage"></div> +<a name="boost.interprocess.basic_managed__idp55490864"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class template basic_managed_external_buffer</span></h2> <p>boost::interprocess::basic_managed_external_buffer</p> @@ -34,53 +34,53 @@ </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharType<span class="special">,</span> <span class="keyword">typename</span> AllocationAlgorithm<span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">IndexConfig</span> <span class="special">></span> <span class="keyword">class</span> IndexType<span class="special">></span> -<span class="keyword">class</span> <a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</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">base_t</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.basic_managed__idp62606272.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">base_t</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.basic_managed__idp55490864.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed__idp62606272.html#boost.interprocess.basic_managed__idp62606272construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_managed__idp62606272.html#idp62614960-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62606272.html#idp62615728-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62606272.html#idp62618544-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62606272.html#idp62621360-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&</span> <a class="link" href="basic_managed__idp62606272.html#idp62622992-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_managed__idp55490864.html#boost.interprocess.basic_managed__idp55490864construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_managed__idp55490864.html#idp55499552-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55490864.html#idp55500320-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55490864.html#idp55503136-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55490864.html#idp55505952-bb"><span class="identifier">basic_managed_external_buffer</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&</span> <a class="link" href="basic_managed__idp55490864.html#idp55507584-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed__idp62606272.html#idp62610368-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="basic_managed__idp62606272.html#idp62610928-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_managed__idp62606272.html#idp62612464-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_managed__idp55490864.html#idp55494960-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_managed__idp55490864.html#idp55495520-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_managed__idp55490864.html#idp55497056-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <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="idp256191808"></a><h2>Description</h2> +<a name="idp275042320"></a><h2>Description</h2> <p>A basic user memory named object creation class. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> </p> <div class="refsect2"> -<a name="idp256192720"></a><h3> -<a name="boost.interprocess.basic_managed__idp62606272construct-copy-destruct"></a><code class="computeroutput">basic_managed_external_buffer</code> +<a name="idp275043232"></a><h3> +<a name="boost.interprocess.basic_managed__idp55490864construct-copy-destruct"></a><code class="computeroutput">basic_managed_external_buffer</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62614960-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55499552-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructor. Does nothing. Useful in combination with move semantics </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62615728-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> addr<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre>Creates and places the segment manager. This can throw. </li> +<pre class="literallayout"><a name="idp55500320-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> addr<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre>Creates and places the segment manager. This can throw. </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62618544-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> addr<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre>Creates and places the segment manager. This can throw. </li> +<pre class="literallayout"><a name="idp55503136-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> addr<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre>Creates and places the segment manager. This can throw. </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62621360-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li> +<pre class="literallayout"><a name="idp55505952-bb"></a><span class="identifier">basic_managed_external_buffer</span><span class="special">(</span><a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&</span> -<a name="idp62622992-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li> +<pre class="literallayout"><a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&</span> +<a name="idp55507584-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li> </ol></div> </div> <div class="refsect2"> -<a name="idp256227664"></a><h3> -<a name="idp62610368-bb"></a><code class="computeroutput">basic_managed_external_buffer</code> public member functions</h3> +<a name="idp275078208"></a><h3> +<a name="idp55494960-bb"></a><code class="computeroutput">basic_managed_external_buffer</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp62610928-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp55495520-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62612464-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55497056-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the ownership of the managed heap memories managed by *this and other. Never throws. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/basic_managed__idp62714784.html b/doc/html/boost/interprocess/basic_managed__idp55599376.html index 6a32f30a79..a3dee77dee 100644 --- a/doc/html/boost/interprocess/basic_managed__idp62714784.html +++ b/doc/html/boost/interprocess/basic_managed__idp55599376.html @@ -24,7 +24,7 @@ <a accesskey="p" href="wmanaged_mapped_file.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="managed_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.basic_managed__idp62714784"></a><div class="titlepage"></div> +<a name="boost.interprocess.basic_managed__idp55599376"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class template basic_managed_shared_memory</span></h2> <p>boost::interprocess::basic_managed_shared_memory</p> @@ -34,105 +34,105 @@ </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharType<span class="special">,</span> <span class="keyword">typename</span> AllocationAlgorithm<span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">IndexConfig</span> <span class="special">></span> <span class="keyword">class</span> IndexType<span class="special">></span> -<span class="keyword">class</span> <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="basic_managed__idp62714784.html#boost.interprocess.basic_managed__idp62714784construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_managed__idp62714784.html#idp62722160-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62714784.html#idp62722928-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> + <span class="comment">// <a class="link" href="basic_managed__idp55599376.html#boost.interprocess.basic_managed__idp55599376construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_managed__idp55599376.html#idp55606752-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55599376.html#idp55607520-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62714784.html#idp62728864-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55599376.html#idp55613456-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62714784.html#idp62734880-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55599376.html#idp55619472-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62714784.html#idp62738144-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55599376.html#idp55622736-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62714784.html#idp62741408-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62714784.html#idp62744656-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&</span> <a class="link" href="basic_managed__idp62714784.html#idp62746416-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62714784.html#idp62721120-bb"><span class="special">~</span><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55599376.html#idp55626000-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55599376.html#idp55629248-bb"><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&</span> <a class="link" href="basic_managed__idp55599376.html#idp55631008-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55599376.html#idp55605712-bb"><span class="special">~</span><span class="identifier">basic_managed_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed__idp62714784.html#idp62718064-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="basic_managed__idp62714784.html#idp62718624-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_managed__idp55599376.html#idp55602656-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_managed__idp55599376.html#idp55603216-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed__idp62714784.html#idp62748768-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed__idp62714784.html#idp62749328-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed__idp62714784.html#idp62752672-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_managed__idp55599376.html#idp55633360-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed__idp55599376.html#idp55633920-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed__idp55599376.html#idp55637264-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp256949968"></a><h2>Description</h2> +<a name="idp275800288"></a><h2>Description</h2> <p>A basic shared memory named object creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> </p> <div class="refsect2"> -<a name="idp256950960"></a><h3> -<a name="boost.interprocess.basic_managed__idp62714784construct-copy-destruct"></a><code class="computeroutput">basic_managed_shared_memory</code> +<a name="idp275801280"></a><h3> +<a name="boost.interprocess.basic_managed__idp55599376construct-copy-destruct"></a><code class="computeroutput">basic_managed_shared_memory</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62722160-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55606752-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructor. Does nothing. Useful in combination with move semantics </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62722928-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">,</span> +<pre class="literallayout"><a name="idp55607520-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates shared memory and creates and places the segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62728864-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55613456-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62734880-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55619472-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created shared memory and its segment manager. in copy_on_write mode. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62738144-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55622736-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created shared memory and its segment manager. in read-only mode. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62741408-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55626000-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created shared memory and its segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62744656-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55629248-bb"></a><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&</span> <a name="idp62746416-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&</span> <a name="idp55631008-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62721120-bb"></a><span class="special">~</span><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55605712-bb"></a><span class="special">~</span><span class="identifier">basic_managed_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp257045232"></a><h3> -<a name="idp62718064-bb"></a><code class="computeroutput">basic_managed_shared_memory</code> public member functions</h3> +<a name="idp275895552"></a><h3> +<a name="idp55602656-bb"></a><code class="computeroutput">basic_managed_shared_memory</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62718624-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55603216-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the ownership of the managed shared memories managed by *this and other. Never throws. </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp257053696"></a><h3> -<a name="idp62748768-bb"></a><code class="computeroutput">basic_managed_shared_memory</code> public static functions</h3> +<a name="idp275904080"></a><h3> +<a name="idp55633360-bb"></a><code class="computeroutput">basic_managed_shared_memory</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp62749328-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> shmname<span class="special">,</span> <span class="identifier">size_type</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp55633920-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> shmname<span class="special">,</span> <span class="identifier">size_type</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre> <p>Tries to resize the managed shared memory object so that we have room for more objects.</p> <p>This function is not synchronized so no other thread or process should be reading or writing the file </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp62752672-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> shmname<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp55637264-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> shmname<span class="special">)</span><span class="special">;</span></pre> <p>Tries to resize the managed shared memory to minimized the size of the file.</p> <p>This function is not synchronized so no other thread or process should be reading or writing the file </p> </li> diff --git a/doc/html/boost/interprocess/basic_managed__idp62772528.html b/doc/html/boost/interprocess/basic_managed__idp55657120.html index 9f982a3fdd..8da906f664 100644 --- a/doc/html/boost/interprocess/basic_managed__idp62772528.html +++ b/doc/html/boost/interprocess/basic_managed__idp55657120.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_hpp" title="Header <boost/interprocess/managed_windows_shared_memory.hpp>"> -<link rel="prev" href="wfixed_managed_idp62766576.html" title="Type definition wfixed_managed_shared_memory"> -<link rel="next" href="managed_window_idp62811600.html" title="Type definition managed_windows_shared_memory"> +<link rel="prev" href="wfixed_managed_idp55651168.html" title="Type definition wfixed_managed_shared_memory"> +<link rel="next" href="managed_window_idp55696192.html" title="Type definition managed_windows_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="wfixed_managed_idp62766576.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="managed_window_idp62811600.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="wfixed_managed_idp55651168.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="managed_window_idp55696192.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.basic_managed__idp62772528"></a><div class="titlepage"></div> +<a name="boost.interprocess.basic_managed__idp55657120"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class template basic_managed_windows_shared_memory</span></h2> <p>boost::interprocess::basic_managed_windows_shared_memory</p> @@ -34,94 +34,94 @@ </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharType<span class="special">,</span> <span class="keyword">typename</span> AllocationAlgorithm<span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">IndexConfig</span> <span class="special">></span> <span class="keyword">class</span> IndexType<span class="special">></span> -<span class="keyword">class</span> <a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</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">base_t</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.basic_managed__idp62772528.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">base_t</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.basic_managed__idp55657120.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed__idp62772528.html#boost.interprocess.basic_managed__idp62772528construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_managed__idp62772528.html#idp62783248-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62772528.html#idp62784016-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> + <span class="comment">// <a class="link" href="basic_managed__idp55657120.html#boost.interprocess.basic_managed__idp55657120construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_managed__idp55657120.html#idp55667840-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55657120.html#idp55668608-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62772528.html#idp62789952-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55657120.html#idp55674544-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62772528.html#idp62795968-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55657120.html#idp55680560-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62772528.html#idp62799216-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55657120.html#idp55683808-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62772528.html#idp62802480-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55657120.html#idp55687072-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62772528.html#idp62805744-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span> - <a class="link" href="basic_managed__idp62772528.html#idp62807504-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62772528.html#idp62809856-bb"><span class="special">~</span><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55657120.html#idp55690336-bb"><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span> + <a class="link" href="basic_managed__idp55657120.html#idp55692096-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55657120.html#idp55694448-bb"><span class="special">~</span><span class="identifier">basic_managed_windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed__idp62772528.html#idp62780192-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="basic_managed__idp62772528.html#idp62780752-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_managed__idp55657120.html#idp55664784-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_managed__idp55657120.html#idp55665344-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <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="idp257284544"></a><h2>Description</h2> -<p>A basic managed windows shared memory creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> Unlike <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a>, it has no kernel persistence and the shared memory is destroyed when all processes destroy all their <a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> objects and mapped regions for the same shared memory or the processes end/crash.</p> -<p>Warning: <a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> and <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> can't communicate between them. </p> +<a name="idp276134992"></a><h2>Description</h2> +<p>A basic managed windows shared memory creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> Unlike <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a>, it has no kernel persistence and the shared memory is destroyed when all processes destroy all their <a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> objects and mapped regions for the same shared memory or the processes end/crash.</p> +<p>Warning: <a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> and <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> can't communicate between them. </p> <div class="refsect2"> -<a name="idp257289568"></a><h3> -<a name="boost.interprocess.basic_managed__idp62772528construct-copy-destruct"></a><code class="computeroutput">basic_managed_windows_shared_memory</code> +<a name="idp276140080"></a><h3> +<a name="boost.interprocess.basic_managed__idp55657120construct-copy-destruct"></a><code class="computeroutput">basic_managed_windows_shared_memory</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62783248-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55667840-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructor. Does nothing. Useful in combination with move semantics </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62784016-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55668608-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates shared memory and creates and places the segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62789952-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55674544-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62795968-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55680560-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created shared memory and its segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62799216-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55683808-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created shared memory and its segment manager in copy_on_write mode. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62802480-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55687072-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created shared memory and its segment manager in read-only mode. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62805744-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55690336-bb"></a><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span> -<a name="idp62807504-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span> +<a name="idp55692096-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62809856-bb"></a><span class="special">~</span><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> -<p>Destroys *this and indicates that the calling process is finished using the resource. All mapped regions are still valid after destruction. When all mapped regions and <code class="computeroutput"><a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a></code> objects referring the shared memory are destroyed, the operating system will destroy the shared memory. </p> +<pre class="literallayout"><a name="idp55694448-bb"></a><span class="special">~</span><span class="identifier">basic_managed_windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<p>Destroys *this and indicates that the calling process is finished using the resource. All mapped regions are still valid after destruction. When all mapped regions and <code class="computeroutput"><a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a></code> objects referring the shared memory are destroyed, the operating system will destroy the shared memory. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp257385120"></a><h3> -<a name="idp62780192-bb"></a><code class="computeroutput">basic_managed_windows_shared_memory</code> public member functions</h3> +<a name="idp276235504"></a><h3> +<a name="idp55664784-bb"></a><code class="computeroutput">basic_managed_windows_shared_memory</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62780752-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55665344-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the ownership of the managed mapped memories managed by *this and other. Never throws. </p> </li></ol></div> </div> @@ -137,7 +137,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="wfixed_managed_idp62766576.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="managed_window_idp62811600.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="wfixed_managed_idp55651168.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="managed_window_idp55696192.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/basic_managed__idp62821248.html b/doc/html/boost/interprocess/basic_managed__idp55705840.html index 250ec682ef..eaa6b5d7f5 100644 --- a/doc/html/boost/interprocess/basic_managed__idp62821248.html +++ b/doc/html/boost/interprocess/basic_managed__idp55705840.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_hpp" title="Header <boost/interprocess/managed_xsi_shared_memory.hpp>"> -<link rel="prev" href="wmanaged_windo_idp62815312.html" title="Type definition wmanaged_windows_shared_memory"> +<link rel="prev" href="wmanaged_windo_idp55699904.html" title="Type definition wmanaged_windows_shared_memory"> <link rel="next" href="managed_xsi_shared_memory.html" title="Type definition managed_xsi_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="wmanaged_windo_idp62815312.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_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="managed_xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="wmanaged_windo_idp55699904.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_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="managed_xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.basic_managed__idp62821248"></a><div class="titlepage"></div> +<a name="boost.interprocess.basic_managed__idp55705840"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class template basic_managed_xsi_shared_memory</span></h2> <p>boost::interprocess::basic_managed_xsi_shared_memory</p> @@ -34,101 +34,101 @@ </span><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> CharType<span class="special">,</span> <span class="keyword">typename</span> AllocationAlgorithm<span class="special">,</span> <span class="keyword">template</span><span class="special"><</span> <span class="keyword">class</span> <span class="identifier">IndexConfig</span> <span class="special">></span> <span class="keyword">class</span> IndexType<span class="special">></span> -<span class="keyword">class</span> <a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</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">base_t</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.basic_managed__idp62821248.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <span class="identifier">base_t</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.basic_managed__idp55705840.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed__idp62821248.html#boost.interprocess.basic_managed__idp62821248construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_managed__idp62821248.html#idp62830624-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62821248.html#idp62831392-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</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="comment">// <a class="link" href="basic_managed__idp55705840.html#boost.interprocess.basic_managed__idp55705840construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="basic_managed__idp55705840.html#idp55715216-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55705840.html#idp55715984-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</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="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62821248.html#idp62837776-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55705840.html#idp55722368-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</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="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62821248.html#idp62844240-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55705840.html#idp55728832-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62821248.html#idp62847952-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">,</span> + <a class="link" href="basic_managed__idp55705840.html#idp55732544-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62821248.html#idp62851648-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&</span> - <a class="link" href="basic_managed__idp62821248.html#idp62853408-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed__idp62821248.html#idp62829584-bb"><span class="special">~</span><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55705840.html#idp55736240-bb"><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&</span> + <a class="link" href="basic_managed__idp55705840.html#idp55738000-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed__idp55705840.html#idp55714176-bb"><span class="special">~</span><span class="identifier">basic_managed_xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed__idp62821248.html#idp62825408-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="basic_managed__idp62821248.html#idp62825968-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="basic_managed__idp62821248.html#idp62828304-bb"><span class="identifier">get_shmid</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="basic_managed__idp55705840.html#idp55710000-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_managed__idp55705840.html#idp55710560-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">int</span> <a class="link" href="basic_managed__idp55705840.html#idp55712896-bb"><span class="identifier">get_shmid</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="basic_managed__idp62821248.html#idp62855760-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed__idp62821248.html#idp62856320-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_managed__idp55705840.html#idp55740352-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed__idp55705840.html#idp55740912-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257575232"></a><h2>Description</h2> +<a name="idp276425552"></a><h2>Description</h2> <p>A basic X/Open System Interface (XSI) shared memory named object creation class. Initializes the shared memory segment. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> </p> <div class="refsect2"> -<a name="idp257576288"></a><h3> -<a name="boost.interprocess.basic_managed__idp62821248construct-copy-destruct"></a><code class="computeroutput">basic_managed_xsi_shared_memory</code> +<a name="idp276426608"></a><h3> +<a name="boost.interprocess.basic_managed__idp55705840construct-copy-destruct"></a><code class="computeroutput">basic_managed_xsi_shared_memory</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62830624-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55715216-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructor. Does nothing. Useful in combination with move semantics </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62831392-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> +<pre class="literallayout"><a name="idp55715984-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates shared memory and creates and places the segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62837776-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> +<pre class="literallayout"><a name="idp55722368-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates shared memory and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62844240-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> +<pre class="literallayout"><a name="idp55728832-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created shared memory and its segment manager. in read-only mode. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62847952-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> +<pre class="literallayout"><a name="idp55732544-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created shared memory and its segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62851648-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55736240-bb"></a><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&</span> -<a name="idp62853408-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&</span> +<a name="idp55738000-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62829584-bb"></a><span class="special">~</span><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55714176-bb"></a><span class="special">~</span><span class="identifier">basic_managed_xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp257662208"></a><h3> -<a name="idp62825408-bb"></a><code class="computeroutput">basic_managed_xsi_shared_memory</code> public member functions</h3> +<a name="idp276512432"></a><h3> +<a name="idp55710000-bb"></a><code class="computeroutput">basic_managed_xsi_shared_memory</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62825968-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55710560-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the ownership of the managed shared memories managed by *this and other. Never throws. </p> </li> -<li class="listitem"><pre class="literallayout"><span class="keyword">int</span> <a name="idp62828304-bb"></a><span class="identifier">get_shmid</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">int</span> <a name="idp55712896-bb"></a><span class="identifier">get_shmid</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp257675648"></a><h3> -<a name="idp62855760-bb"></a><code class="computeroutput">basic_managed_xsi_shared_memory</code> public static functions</h3> +<a name="idp276525712"></a><h3> +<a name="idp55740352-bb"></a><code class="computeroutput">basic_managed_xsi_shared_memory</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp62856320-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">int</span> shmid<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp55740912-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">int</span> shmid<span class="special">)</span><span class="special">;</span></pre> <p>Erases a XSI shared memory object identified by shmid from the system. Returns false on error. Never throws </p> </li></ol></div> </div> @@ -144,7 +144,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="wmanaged_windo_idp62815312.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_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="managed_xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="wmanaged_windo_idp55699904.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_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="managed_xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/basic_managed_heap_memory.html b/doc/html/boost/interprocess/basic_managed_heap_memory.html index ac46cd4377..5561ccc51d 100644 --- a/doc/html/boost/interprocess/basic_managed_heap_memory.html +++ b/doc/html/boost/interprocess/basic_managed_heap_memory.html @@ -40,53 +40,53 @@ <span class="keyword">typedef</span> <span class="identifier">base_t</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.basic_managed_heap_memory.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_managed_heap_memory.html#boost.interprocess.basic_managed_heap_memoryconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_managed_heap_memory.html#idp62644720-bb"><span class="identifier">basic_managed_heap_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_heap_memory.html#idp62646256-bb"><span class="identifier">basic_managed_heap_memory</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_heap_memory.html#idp62647712-bb"><span class="identifier">basic_managed_heap_memory</span></a><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&</span> <a class="link" href="basic_managed_heap_memory.html#idp62649344-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_heap_memory.html#idp62645488-bb"><span class="special">~</span><span class="identifier">basic_managed_heap_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_heap_memory.html#idp55529312-bb"><span class="identifier">basic_managed_heap_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_heap_memory.html#idp55530848-bb"><span class="identifier">basic_managed_heap_memory</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_heap_memory.html#idp55532304-bb"><span class="identifier">basic_managed_heap_memory</span></a><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&</span> <a class="link" href="basic_managed_heap_memory.html#idp55533936-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_heap_memory.html#idp55530080-bb"><span class="special">~</span><span class="identifier">basic_managed_heap_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed_heap_memory.html#idp62639264-bb">public member functions</a></span> - <span class="keyword">bool</span> <a class="link" href="basic_managed_heap_memory.html#idp62639824-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_managed_heap_memory.html#idp62642224-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_managed_heap_memory.html#idp55523856-bb">public member functions</a></span> + <span class="keyword">bool</span> <a class="link" href="basic_managed_heap_memory.html#idp55524416-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_managed_heap_memory.html#idp55526816-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <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="idp256363856"></a><h2>Description</h2> +<a name="idp275214560"></a><h2>Description</h2> <p>A basic heap memory named object creation class. Initializes the heap memory segment. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> </p> <div class="refsect2"> -<a name="idp256364848"></a><h3> +<a name="idp275215552"></a><h3> <a name="boost.interprocess.basic_managed_heap_memoryconstruct-copy-destruct"></a><code class="computeroutput">basic_managed_heap_memory</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62644720-bb"></a><span class="identifier">basic_managed_heap_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55529312-bb"></a><span class="identifier">basic_managed_heap_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructor. Does nothing. Useful in combination with move semantics </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62646256-bb"></a><span class="identifier">basic_managed_heap_memory</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55530848-bb"></a><span class="identifier">basic_managed_heap_memory</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> <p>Creates heap memory and initializes the segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62647712-bb"></a><span class="identifier">basic_managed_heap_memory</span><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li> +<pre class="literallayout"><a name="idp55532304-bb"></a><span class="identifier">basic_managed_heap_memory</span><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&</span> <a name="idp62649344-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li> +<pre class="literallayout"><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&</span> <a name="idp55533936-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre>Moves the ownership of "moved"'s managed memory to *this. Does not throw. </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62645488-bb"></a><span class="special">~</span><span class="identifier">basic_managed_heap_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55530080-bb"></a><span class="special">~</span><span class="identifier">basic_managed_heap_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destructor. Liberates the heap memory holding the managed data. Never throws. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp256393296"></a><h3> -<a name="idp62639264-bb"></a><code class="computeroutput">basic_managed_heap_memory</code> public member functions</h3> +<a name="idp275243856"></a><h3> +<a name="idp55523856-bb"></a><code class="computeroutput">basic_managed_heap_memory</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62639824-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55524416-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre> <p>Tries to resize internal heap memory so that we have room for more objects. WARNING: If memory is reallocated, all the objects will be binary-copied to the new buffer. To be able to use this function, all pointers constructed in this buffer must be offset pointers. Otherwise, the result is undefined. Returns true if the growth has been successful, so you will have some extra bytes to allocate new objects. If returns false, the heap allocation has failed. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62642224-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55526816-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the ownership of the managed heap memories managed by *this and other. Never throws. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/basic_managed_mapped_file.html b/doc/html/boost/interprocess/basic_managed_mapped_file.html index a05aa768eb..f1ac0d8a68 100644 --- a/doc/html/boost/interprocess/basic_managed_mapped_file.html +++ b/doc/html/boost/interprocess/basic_managed_mapped_file.html @@ -40,34 +40,34 @@ <span class="keyword">typedef</span> <span class="identifier">implementation_defined</span> <a class="link" href="basic_managed_mapped_file.html#boost.interprocess.basic_managed_mapped_file.size_type"><span class="identifier">size_type</span></a><span class="special">;</span> <span class="comment">// <a class="link" href="basic_managed_mapped_file.html#boost.interprocess.basic_managed_mapped_fileconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_managed_mapped_file.html#idp62670864-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_mapped_file.html#idp62671632-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> + <a class="link" href="basic_managed_mapped_file.html#idp55555456-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_mapped_file.html#idp55556224-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_mapped_file.html#idp62677568-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> + <a class="link" href="basic_managed_mapped_file.html#idp55562160-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_mapped_file.html#idp62683584-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_mapped_file.html#idp62686832-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="basic_managed_mapped_file.html#idp55568176-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_mapped_file.html#idp55571424-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_mapped_file.html#idp62690096-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_mapped_file.html#idp62693360-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&</span> <a class="link" href="basic_managed_mapped_file.html#idp62695120-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_managed_mapped_file.html#idp62697472-bb"><span class="special">~</span><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_mapped_file.html#idp55574688-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_mapped_file.html#idp55577952-bb"><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&</span> <a class="link" href="basic_managed_mapped_file.html#idp55579712-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_managed_mapped_file.html#idp55582064-bb"><span class="special">~</span><span class="identifier">basic_managed_mapped_file</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed_mapped_file.html#idp62666512-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="basic_managed_mapped_file.html#idp62667072-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="basic_managed_mapped_file.html#idp62669408-bb"><span class="identifier">flush</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_managed_mapped_file.html#idp55551104-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_managed_mapped_file.html#idp55551664-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="basic_managed_mapped_file.html#idp55554000-bb"><span class="identifier">flush</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_managed_mapped_file.html#idp62698512-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed_mapped_file.html#idp62699072-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed_mapped_file.html#idp62702400-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_managed_mapped_file.html#idp55583104-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed_mapped_file.html#idp55583664-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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">static</span> <span class="keyword">bool</span> <a class="link" href="basic_managed_mapped_file.html#idp55586992-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp256604112"></a><h2>Description</h2> +<a name="idp275454304"></a><h2>Description</h2> <p>A basic mapped file named object creation class. Initializes the mapped file. Inherits all basic functionality from basic_managed_memory_impl<CharType, AllocationAlgorithm, IndexType> </p> <div class="refsect2"> -<a name="idp256605088"></a><h3> +<a name="idp275455280"></a><h3> <a name="boost.interprocess.basic_managed_mapped_filetypes"></a><code class="computeroutput">basic_managed_mapped_file</code> public types</h3> @@ -78,81 +78,81 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="idp256612080"></a><h3> +<a name="idp275462272"></a><h3> <a name="boost.interprocess.basic_managed_mapped_fileconstruct-copy-destruct"></a><code class="computeroutput">basic_managed_mapped_file</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62670864-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55555456-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates mapped file and creates and places the segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62671632-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">,</span> +<pre class="literallayout"><a name="idp55556224-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates mapped file and creates and places the segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62677568-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">,</span> +<pre class="literallayout"><a name="idp55562160-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> size<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates mapped file and creates and places the segment manager if segment was not created. If segment was created it connects to the segment. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62683584-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55568176-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created mapped file and its segment manager. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62686832-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55571424-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created mapped file and its segment manager in copy_on_write mode. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62690096-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55574688-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> addr <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Connects to a created mapped file and its segment manager in read-only mode. This can throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62693360-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55577952-bb"></a><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&</span> <a name="idp62695120-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&</span> <a name="idp55579712-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s managed memory to *this. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62697472-bb"></a><span class="special">~</span><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55582064-bb"></a><span class="special">~</span><span class="identifier">basic_managed_mapped_file</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp256706272"></a><h3> -<a name="idp62666512-bb"></a><code class="computeroutput">basic_managed_mapped_file</code> public member functions</h3> +<a name="idp275556464"></a><h3> +<a name="idp55551104-bb"></a><code class="computeroutput">basic_managed_mapped_file</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62667072-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55551664-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the ownership of the managed mapped memories managed by *this and other. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62669408-bb"></a><span class="identifier">flush</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55554000-bb"></a><span class="identifier">flush</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Flushes cached data to file. Never throws </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp256719376"></a><h3> -<a name="idp62698512-bb"></a><code class="computeroutput">basic_managed_mapped_file</code> public static functions</h3> +<a name="idp275569440"></a><h3> +<a name="idp55583104-bb"></a><code class="computeroutput">basic_managed_mapped_file</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp62699072-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">,</span> <span class="identifier">size_type</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp55583664-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">,</span> <span class="identifier">size_type</span> extra_bytes<span class="special">)</span><span class="special">;</span></pre> <p>Tries to resize mapped file so that we have room for more objects.</p> <p>This function is not synchronized so no other thread or process should be reading or writing the file </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp62702400-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp55586992-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">)</span><span class="special">;</span></pre> <p>Tries to resize mapped file to minimized the size of the file.</p> <p>This function is not synchronized so no other thread or process should be reading or writing the file </p> </li> diff --git a/doc/html/boost/interprocess/basic_obufferstream.html b/doc/html/boost/interprocess/basic_obufferstream.html index cc132204eb..691fa0389f 100644 --- a/doc/html/boost/interprocess/basic_obufferstream.html +++ b/doc/html/boost/interprocess/basic_obufferstream.html @@ -43,51 +43,51 @@ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">traits_type</span> <a name="boost.interprocess.basic_obufferstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_obufferstream.html#boost.interprocess.basic_obufferstreamconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_obufferstream.html#idp63778384-bb"><span class="identifier">basic_obufferstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_obufferstream.html#idp63780080-bb"><span class="identifier">basic_obufferstream</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> + <a class="link" href="basic_obufferstream.html#idp56662976-bb"><span class="identifier">basic_obufferstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_obufferstream.html#idp56664672-bb"><span class="identifier">basic_obufferstream</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="basic_obufferstream.html#idp63783184-bb"><span class="special">~</span><span class="identifier">basic_obufferstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_obufferstream.html#idp56667776-bb"><span class="special">~</span><span class="identifier">basic_obufferstream</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_obufferstream.html#idp63771504-bb">public member functions</a></span> - <a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_obufferstream.html#idp63772064-bb"><span class="identifier">rdbuf</span></a><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">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="basic_obufferstream.html#idp63773920-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_obufferstream.html#idp63775520-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="comment">// <a class="link" href="basic_obufferstream.html#idp56656096-bb">public member functions</a></span> + <a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_obufferstream.html#idp56656656-bb"><span class="identifier">rdbuf</span></a><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">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a class="link" href="basic_obufferstream.html#idp56658512-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_obufferstream.html#idp56660112-bb"><span class="identifier">buffer</span></a><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</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="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp263439120"></a><h2>Description</h2> +<a name="idp282290608"></a><h2>Description</h2> <p>A basic_ostream class that uses a fixed size character buffer as its formatting buffer. </p> <div class="refsect2"> -<a name="idp263439904"></a><h3> +<a name="idp282291392"></a><h3> <a name="boost.interprocess.basic_obufferstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_obufferstream</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63778384-bb"></a><span class="identifier">basic_obufferstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56662976-bb"></a><span class="identifier">basic_obufferstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63780080-bb"></a><span class="identifier">basic_obufferstream</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span> +<pre class="literallayout"><a name="idp56664672-bb"></a><span class="identifier">basic_obufferstream</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Assigns formatting buffer. Does not throw. </p> </li> -<li class="listitem"><pre class="literallayout"><a name="idp63783184-bb"></a><span class="special">~</span><span class="identifier">basic_obufferstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp56667776-bb"></a><span class="special">~</span><span class="identifier">basic_obufferstream</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp263470944"></a><h3> -<a name="idp63771504-bb"></a><code class="computeroutput">basic_obufferstream</code> public member functions</h3> +<a name="idp282322432"></a><h3> +<a name="idp56656096-bb"></a><code class="computeroutput">basic_obufferstream</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp63772064-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_bufferbuf.html" title="Class template basic_bufferbuf">basic_bufferbuf</a><span class="special"><</span> <span class="identifier">CharT</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp56656656-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the address of the stored stream buffer. </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">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="idp63773920-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">CharT</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="special">></span> <a name="idp56658512-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the pointer and size of the internal buffer. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63775520-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56660112-bb"></a><span class="identifier">buffer</span><span class="special">(</span><span class="identifier">CharT</span> <span class="special">*</span> buf<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> length<span class="special">)</span><span class="special">;</span></pre> <p>Sets the underlying buffer to a new value. Resets stream position. Does not throw. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/basic_ovectorstream.html b/doc/html/boost/interprocess/basic_ovectorstream.html index d80f1307b3..2a2db94c4b 100644 --- a/doc/html/boost/interprocess/basic_ovectorstream.html +++ b/doc/html/boost/interprocess/basic_ovectorstream.html @@ -46,56 +46,56 @@ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">traits_type</span> <a name="boost.interprocess.basic_ovectorstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_ovectorstream.html#boost.interprocess.basic_ovectorstreamconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_ovectorstream.html#idp63878128-bb"><span class="identifier">basic_ovectorstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_ovectorstream.html#idp56762720-bb"><span class="identifier">basic_ovectorstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <a class="link" href="basic_ovectorstream.html#idp63879856-bb"><span class="identifier">basic_ovectorstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> + <a class="link" href="basic_ovectorstream.html#idp56764448-bb"><span class="identifier">basic_ovectorstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_ovectorstream.html#idp63869792-bb">public member functions</a></span> - <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_ovectorstream.html#idp63870352-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_ovectorstream.html#idp63872224-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_ovectorstream.html#idp63874288-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_ovectorstream.html#idp63875872-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_ovectorstream.html#idp56754384-bb">public member functions</a></span> + <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_ovectorstream.html#idp56754944-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ovectorstream.html#idp56756816-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_ovectorstream.html#idp56758880-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_ovectorstream.html#idp56760464-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp264196384"></a><h2>Description</h2> +<a name="idp283048064"></a><h2>Description</h2> <p>A basic_ostream class that holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </p> <div class="refsect2"> -<a name="idp264197312"></a><h3> +<a name="idp283048992"></a><h3> <a name="boost.interprocess.basic_ovectorstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_ovectorstream</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63878128-bb"></a><span class="identifier">basic_ovectorstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56762720-bb"></a><span class="identifier">basic_ovectorstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type default constructor throws. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <a name="idp63879856-bb"></a><span class="identifier">basic_ovectorstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> + <a name="idp56764448-bb"></a><span class="identifier">basic_ovectorstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type(const VectorParameter &param) throws. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp264225168"></a><h3> -<a name="idp63869792-bb"></a><code class="computeroutput">basic_ovectorstream</code> public member functions</h3> +<a name="idp283076912"></a><h3> +<a name="idp56754384-bb"></a><code class="computeroutput">basic_ovectorstream</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp63870352-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp56754944-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the address of the stored stream buffer. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63872224-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56756816-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the underlying vector with the passed vector. This function resets the write position in the stream. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp63874288-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp56758880-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a const reference to the internal vector. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63875872-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56760464-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> <p>Calls reserve() method of the internal vector. Resets the stream to the first position. Throws if the internals vector's reserve throws. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/basic_vectorbuf.html b/doc/html/boost/interprocess/basic_vectorbuf.html index 2be57fef8e..4e514dc7fb 100644 --- a/doc/html/boost/interprocess/basic_vectorbuf.html +++ b/doc/html/boost/interprocess/basic_vectorbuf.html @@ -46,56 +46,56 @@ <span class="keyword">typedef</span> <span class="identifier">CharTraits</span> <a name="boost.interprocess.basic_vectorbuf.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_vectorbuf.html#boost.interprocess.basic_vectorbufconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="basic_vectorbuf.html#idp63832864-bb"><span class="identifier">basic_vectorbuf</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="basic_vectorbuf.html#idp56717456-bb"><span class="identifier">basic_vectorbuf</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <span class="keyword">explicit</span> <a class="link" href="basic_vectorbuf.html#idp63834880-bb"><span class="identifier">basic_vectorbuf</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> + <span class="keyword">explicit</span> <a class="link" href="basic_vectorbuf.html#idp56719472-bb"><span class="identifier">basic_vectorbuf</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_vectorbuf.html#idp63825072-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp63825632-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_vectorbuf.html#idp63827696-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp63829280-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</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="basic_vectorbuf.html#idp63831376-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_vectorbuf.html#idp56709664-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp56710224-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_vectorbuf.html#idp56712288-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_vectorbuf.html#idp56713872-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</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="basic_vectorbuf.html#idp56715968-bb"><span class="identifier">clear</span></a><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="idp263824000"></a><h2>Description</h2> +<a name="idp282675808"></a><h2>Description</h2> <p>A streambuf class that controls the transmission of elements to and from a <a class="link" href="basic_ivectorstream.html" title="Class template basic_ivectorstream">basic_ivectorstream</a>, <a class="link" href="basic_ovectorstream.html" title="Class template basic_ovectorstream">basic_ovectorstream</a> or <a class="link" href="basic_vectorstream.html" title="Class template basic_vectorstream">basic_vectorstream</a>. It holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </p> <div class="refsect2"> -<a name="idp263827584"></a><h3> +<a name="idp282679392"></a><h3> <a name="boost.interprocess.basic_vectorbufconstruct-copy-destruct"></a><code class="computeroutput">basic_vectorbuf</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp63832864-bb"></a><span class="identifier">basic_vectorbuf</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56717456-bb"></a><span class="identifier">basic_vectorbuf</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type default constructor throws. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <span class="keyword">explicit</span> <a name="idp63834880-bb"></a><span class="identifier">basic_vectorbuf</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> + <span class="keyword">explicit</span> <a name="idp56719472-bb"></a><span class="identifier">basic_vectorbuf</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type(const VectorParameter &param) throws. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp263863216"></a><h3> -<a name="idp63825072-bb"></a><code class="computeroutput">basic_vectorbuf</code> public member functions</h3> +<a name="idp282715008"></a><h3> +<a name="idp56709664-bb"></a><code class="computeroutput">basic_vectorbuf</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63825632-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56710224-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the underlying vector with the passed vector. This function resets the read/write position in the stream. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp63827696-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp56712288-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a const reference to the internal vector. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63829280-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56713872-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> <p>Preallocates memory from the internal vector. Resets the stream to the first position. Throws if the internals vector's memory allocation throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63831376-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56715968-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Calls clear() method of the internal vector. Resets the stream to the first position. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/basic_vectorstream.html b/doc/html/boost/interprocess/basic_vectorstream.html index 1853bba73a..7b95548475 100644 --- a/doc/html/boost/interprocess/basic_vectorstream.html +++ b/doc/html/boost/interprocess/basic_vectorstream.html @@ -46,58 +46,58 @@ <span class="keyword">typedef</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ios</span><span class="special"><</span> <span class="identifier">char_type</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span><span class="special">::</span><span class="identifier">traits_type</span> <a name="boost.interprocess.basic_vectorstream.traits_type"></a><span class="identifier">traits_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="basic_vectorstream.html#boost.interprocess.basic_vectorstreamconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="basic_vectorstream.html#idp63900688-bb"><span class="identifier">basic_vectorstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="basic_vectorstream.html#idp56785280-bb"><span class="identifier">basic_vectorstream</span></a><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <a class="link" href="basic_vectorstream.html#idp63902432-bb"><span class="identifier">basic_vectorstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> + <a class="link" href="basic_vectorstream.html#idp56787024-bb"><span class="identifier">basic_vectorstream</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="basic_vectorstream.html#idp63891472-bb">public member functions</a></span> - <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_vectorstream.html#idp63892032-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_vectorstream.html#idp63893456-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_vectorstream.html#idp63895520-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="basic_vectorstream.html#idp63897104-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</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="basic_vectorstream.html#idp63899200-bb"><span class="identifier">clear</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="basic_vectorstream.html#idp56776064-bb">public member functions</a></span> + <a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a class="link" href="basic_vectorstream.html#idp56776624-bb"><span class="identifier">rdbuf</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_vectorstream.html#idp56778048-bb"><span class="identifier">swap_vector</span></a><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a class="link" href="basic_vectorstream.html#idp56780112-bb"><span class="identifier">vector</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="basic_vectorstream.html#idp56781696-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</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="basic_vectorstream.html#idp56783792-bb"><span class="identifier">clear</span></a><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="idp264385440"></a><h2>Description</h2> +<a name="idp283237360"></a><h2>Description</h2> <p>A basic_iostream class that holds a character vector specified by CharVector template parameter as its formatting buffer. The vector must have contiguous storage, like std::vector, boost::interprocess::vector or boost::interprocess::basic_string </p> <div class="refsect2"> -<a name="idp264386368"></a><h3> +<a name="idp283238288"></a><h3> <a name="boost.interprocess.basic_vectorstreamconstruct-copy-destruct"></a><code class="computeroutput">basic_vectorstream</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63900688-bb"></a><span class="identifier">basic_vectorstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56785280-bb"></a><span class="identifier">basic_vectorstream</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type default constructor throws. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> VectorParameter<span class="special">></span> - <a name="idp63902432-bb"></a><span class="identifier">basic_vectorstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> + <a name="idp56787024-bb"></a><span class="identifier">basic_vectorstream</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">VectorParameter</span> <span class="special">&</span> param<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">openmode</span> mode <span class="special">=</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">in</span><span class="special">|</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">ios_base</span><span class="special">::</span><span class="identifier">out</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws if vector_type(const VectorParameter &param) throws. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp264420544"></a><h3> -<a name="idp63891472-bb"></a><code class="computeroutput">basic_vectorstream</code> public member functions</h3> +<a name="idp283272400"></a><h3> +<a name="idp56776064-bb"></a><code class="computeroutput">basic_vectorstream</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp63892032-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="basic_vectorbuf.html" title="Class template basic_vectorbuf">basic_vectorbuf</a><span class="special"><</span> <span class="identifier">CharVector</span><span class="special">,</span> <span class="identifier">CharTraits</span> <span class="special">></span> <span class="special">*</span> <a name="idp56776624-bb"></a><span class="identifier">rdbuf</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63893456-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56778048-bb"></a><span class="identifier">swap_vector</span><span class="special">(</span><span class="identifier">vector_type</span> <span class="special">&</span> vect<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the underlying vector with the passed vector. This function resets the read/write position in the stream. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp63895520-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">vector_type</span> <span class="special">&</span> <a name="idp56780112-bb"></a><span class="identifier">vector</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a const reference to the internal vector. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63897104-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56781696-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">vector_type</span><span class="special">::</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> <p>Calls reserve() method of the internal vector. Resets the stream to the first position. Throws if the internals vector's reserve throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63899200-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56783792-bb"></a><span class="identifier">clear</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Calls clear() method of the internal vector. Resets the stream to the first position. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/cached_adaptive_pool.html b/doc/html/boost/interprocess/cached_adaptive_pool.html index 593a8de4b8..533c431000 100644 --- a/doc/html/boost/interprocess/cached_adaptive_pool.html +++ b/doc/html/boost/interprocess/cached_adaptive_pool.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_hpp" title="Header <boost/interprocess/allocators/cached_adaptive_pool.hpp>"> -<link rel="prev" href="operator___idp61721376.html" title="Function template operator!="> +<link rel="prev" href="operator___idp54605968.html" title="Function template operator!="> <link rel="next" href="cached_adaptive_pool/rebind.html" title="Struct template rebind"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61721376.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54605968.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.cached_adaptive_pool"></a><div class="titlepage"></div> @@ -55,183 +55,183 @@ <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="cached_adaptive_pool.html#boost.interprocess.cached_adaptive_poolconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="cached_adaptive_pool.html#idp61809648-bb"><span class="identifier">cached_adaptive_pool</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="cached_adaptive_pool.html#idp61811920-bb"><span class="identifier">cached_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="cached_adaptive_pool.html#idp54694240-bb"><span class="identifier">cached_adaptive_pool</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="cached_adaptive_pool.html#idp54696512-bb"><span class="identifier">cached_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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_adaptive_pool.html#idp61814592-bb"><span class="identifier">cached_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="cached_adaptive_pool.html#idp54699184-bb"><span class="identifier">cached_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</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> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> F2<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> OP2<span class="special">></span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span> - <a class="link" href="cached_adaptive_pool.html#idp61749200-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_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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="identifier">F2</span><span class="special">,</span> <span class="identifier">OP2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span> <a class="link" href="cached_adaptive_pool.html#idp61756352-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_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="cached_adaptive_pool.html#idp61818944-bb"><span class="special">~</span><span class="identifier">cached_adaptive_pool</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="cached_adaptive_pool.html#idp54633792-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_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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="identifier">F2</span><span class="special">,</span> <span class="identifier">OP2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span> <a class="link" href="cached_adaptive_pool.html#idp54640944-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_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="cached_adaptive_pool.html#idp54703536-bb"><span class="special">~</span><span class="identifier">cached_adaptive_pool</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="cached_adaptive_pool.html#idp61759536-bb">public member functions</a></span> - <span class="identifier">node_pool_t</span> <span class="special">*</span> <a class="link" href="cached_adaptive_pool.html#idp61760096-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="cached_adaptive_pool.html#idp61761664-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_adaptive_pool.html#idp61763232-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_adaptive_pool.html#idp61764816-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_adaptive_pool.html#idp61768544-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_adaptive_pool.html#idp61771216-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_adaptive_pool.html#idp61772512-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_adaptive_pool.html#idp61774768-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_adaptive_pool.html#idp61777024-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_adaptive_pool.html#idp61779712-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_adaptive_pool.html#idp61781696-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">pointer</span> <a class="link" href="cached_adaptive_pool.html#idp61784096-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="comment">// <a class="link" href="cached_adaptive_pool.html#idp54644128-bb">public member functions</a></span> + <span class="identifier">node_pool_t</span> <span class="special">*</span> <a class="link" href="cached_adaptive_pool.html#idp54644688-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="cached_adaptive_pool.html#idp54646256-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_adaptive_pool.html#idp54647824-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_adaptive_pool.html#idp54649408-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_adaptive_pool.html#idp54653136-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_adaptive_pool.html#idp54655808-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_adaptive_pool.html#idp54657104-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_adaptive_pool.html#idp54659360-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_adaptive_pool.html#idp54661616-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_adaptive_pool.html#idp54664304-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_adaptive_pool.html#idp54666288-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">pointer</span> <a class="link" href="cached_adaptive_pool.html#idp54668688-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="special">,</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_adaptive_pool.html#idp61787728-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> - <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp61791360-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> - <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp61794800-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> - <span class="identifier">pointer</span> <a class="link" href="cached_adaptive_pool.html#idp61797056-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_adaptive_pool.html#idp61799184-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp61801456-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_adaptive_pool.html#idp61803584-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="special">;</span> - <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp61805856-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> - <span class="identifier">size_type</span> <a class="link" href="cached_adaptive_pool.html#idp61807920-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="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp54672320-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> + <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp54675952-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> + <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp54679392-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> + <span class="identifier">pointer</span> <a class="link" href="cached_adaptive_pool.html#idp54681648-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_adaptive_pool.html#idp54683776-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp54686048-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_adaptive_pool.html#idp54688176-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="special">;</span> + <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp54690448-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> + <span class="identifier">size_type</span> <a class="link" href="cached_adaptive_pool.html#idp54692512-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_adaptive_pool.html#idp61819728-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp61820288-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="cached_adaptive_pool.html#idp54704320-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="cached_adaptive_pool.html#idp54704880-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="idp251649184"></a><h2>Description</h2> +<a name="idp270500256"></a><h2>Description</h2> <p>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc...</p> <p>This node allocator shares a segregated storage between all instances of <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> with equal sizeof(T) placed in the same memory segment. But also caches some nodes privately to avoid some synchronization overhead.</p> <p>NodesPerBlock is the minimum number of nodes of nodes allocated at once when the allocator needs runs out of nodes. MaxFreeBlocks is the maximum number of totally free blocks that the adaptive node pool will hold. The rest of the totally free blocks will be deallocated with the segment manager.</p> <p>OverheadPercent is the (approximated) maximum size overhead (1-20%) of the allocator: (memory usable for nodes / total memory allocated from the segment manager) </p> <div class="refsect2"> -<a name="idp251652496"></a><h3> +<a name="idp270503568"></a><h3> <a name="boost.interprocess.cached_adaptive_poolconstruct-copy-destruct"></a><code class="computeroutput">cached_adaptive_pool</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp61809648-bb"></a><span class="identifier">cached_adaptive_pool</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54694240-bb"></a><span class="identifier">cached_adaptive_pool</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> <p>Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp61811920-bb"></a><span class="identifier">cached_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54696512-bb"></a><span class="identifier">cached_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from other <code class="computeroutput"><a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a></code>. Increments the reference count of the associated node pool. Never throws </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> - <a name="idp61814592-bb"></a><span class="identifier">cached_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> + <a name="idp54699184-bb"></a><span class="identifier">cached_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from related <code class="computeroutput"><a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a></code>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> SegmentManager2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> F2<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> OP2<span class="special">></span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span> - <a name="idp61749200-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_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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="identifier">F2</span><span class="special">,</span> <span class="identifier">OP2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp54633792-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_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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="identifier">F2</span><span class="special">,</span> <span class="identifier">OP2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from related <code class="computeroutput"><a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span> <a name="idp61756352-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_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span> <a name="idp54640944-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_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from other <code class="computeroutput"><a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp61818944-bb"></a><span class="special">~</span><span class="identifier">cached_adaptive_pool</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54703536-bb"></a><span class="special">~</span><span class="identifier">cached_adaptive_pool</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="idp251727408"></a><h3> -<a name="idp61759536-bb"></a><code class="computeroutput">cached_adaptive_pool</code> public member functions</h3> +<a name="idp270578272"></a><h3> +<a name="idp54644128-bb"></a><code class="computeroutput">cached_adaptive_pool</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="idp61760096-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">node_pool_t</span> <span class="special">*</span> <a name="idp54644688-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a pointer to the node pool. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp61761664-bb"></a><span class="identifier">get_segment_manager</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp54646256-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="idp61763232-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54647824-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="idp61764816-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54649408-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocate memory for an array of count elements. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61768544-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54653136-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="idp61771216-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54655808-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="idp61772512-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54657104-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="idp61774768-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">const_reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idp54659360-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="idp61777024-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54661616-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> <p>Copy construct an object. Throws if T's copy constructor throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61779712-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54664304-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="idp61781696-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54666288-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">pointer</span> <a name="idp61784096-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> +<li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54668688-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> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">pointer</span> <span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61787728-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54672320-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">size_type</span> num_elements<span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&</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="keyword">void</span> <a name="idp61791360-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54675952-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<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="idp61794800-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54679392-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> <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="idp61797056-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54681648-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">multiallocation_chain</span> <a name="idp61799184-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">multiallocation_chain</span> <a name="idp54683776-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">)</span><span class="special">;</span></pre> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61801456-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54686048-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="idp61803584-bb"></a><span class="identifier">deallocate_individual</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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54688176-bb"></a><span class="identifier">deallocate_individual</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> <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="idp61805856-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54690448-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> <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">size_type</span> <a name="idp61807920-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> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54692512-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="idp251876384"></a><h3> -<a name="idp61819728-bb"></a><code class="computeroutput">cached_adaptive_pool</code> friend functions</h3> +<a name="idp270727184"></a><h3> +<a name="idp54704320-bb"></a><code class="computeroutput">cached_adaptive_pool</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="idp61820288-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp54704880-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> @@ -247,7 +247,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61721376.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54605968.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/cached_adaptive_pool/rebind.html b/doc/html/boost/interprocess/cached_adaptive_pool/rebind.html index 9349e7a9db..ad49f97ca8 100644 --- a/doc/html/boost/interprocess/cached_adaptive_pool/rebind.html +++ b/doc/html/boost/interprocess/cached_adaptive_pool/rebind.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../cached_adaptive_pool.html#idp251649184" title="Description"> +<link rel="up" href="../cached_adaptive_pool.html#idp270500256" title="Description"> <link rel="prev" href="../cached_adaptive_pool.html" title="Class template cached_adaptive_pool"> -<link rel="next" href="../operator___idp61823344.html" title="Function template operator=="> +<link rel="next" href="../operator___idp54707936.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../cached_adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cached_adaptive_pool.html#idp251649184"><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="../operator___idp61823344.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../cached_adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cached_adaptive_pool.html#idp270500256"><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="../operator___idp54707936.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.cached_adaptive_pool.rebind"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <span class="keyword">typedef</span> <a class="link" href="../cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <a name="boost.interprocess.cached_adaptive_pool.rebind.other"></a><span class="identifier">other</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp251908160"></a><h2>Description</h2> +<a name="idp270759024"></a><h2>Description</h2> <p>Obtains <a class="link" href="../cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> from <a class="link" href="../cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a> </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../cached_adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cached_adaptive_pool.html#idp251649184"><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="../operator___idp61823344.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../cached_adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cached_adaptive_pool.html#idp270500256"><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="../operator___idp54707936.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/cached_node_allocator.html b/doc/html/boost/interprocess/cached_node_allocator.html index dae1ade7f1..231ac006c9 100644 --- a/doc/html/boost/interprocess/cached_node_allocator.html +++ b/doc/html/boost/interprocess/cached_node_allocator.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <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>"> -<link rel="prev" href="operator___idp61831632.html" title="Function template operator!="> +<link rel="prev" href="operator___idp54716224.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"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61831632.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> +<a accesskey="p" href="operator___idp54716224.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> </div> <div class="refentry"> <a name="boost.interprocess.cached_node_allocator"></a><div class="titlepage"></div> @@ -54,177 +54,177 @@ <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#idp61916912-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> - <a class="link" href="cached_node_allocator.html#idp61919184-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> + <a class="link" href="cached_node_allocator.html#idp54801504-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> + <a class="link" href="cached_node_allocator.html#idp54803776-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#idp61921856-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> + <a class="link" href="cached_node_allocator.html#idp54806448-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> <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#idp61858160-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> - <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#idp61863616-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#idp61926176-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> + <a class="link" href="cached_node_allocator.html#idp54742752-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> + <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#idp54748208-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#idp54810768-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#idp61866800-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#idp61867360-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="cached_node_allocator.html#idp61868928-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#idp61870496-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#idp61872080-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#idp61875808-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#idp61878480-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#idp61879776-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#idp61882032-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#idp61884288-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#idp61886976-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#idp61888960-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">pointer</span> <a class="link" href="cached_node_allocator.html#idp61891360-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="comment">// <a class="link" href="cached_node_allocator.html#idp54751392-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#idp54751952-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="cached_node_allocator.html#idp54753520-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#idp54755088-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#idp54756672-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#idp54760400-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#idp54763072-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#idp54764368-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#idp54766624-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#idp54768880-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#idp54771568-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#idp54773552-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">pointer</span> <a class="link" href="cached_node_allocator.html#idp54775952-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="special">,</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#idp61894992-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> - <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idp61898624-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> - <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idp61902064-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> - <span class="identifier">pointer</span> <a class="link" href="cached_node_allocator.html#idp61904320-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#idp61906448-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idp61908720-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#idp61910848-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#idp61913120-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> - <span class="identifier">size_type</span> <a class="link" href="cached_node_allocator.html#idp61915184-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="keyword">void</span> <a class="link" href="cached_node_allocator.html#idp54779584-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> + <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idp54783216-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> + <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idp54786656-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> + <span class="identifier">pointer</span> <a class="link" href="cached_node_allocator.html#idp54788912-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#idp54791040-bb"><span class="identifier">allocate_individual</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idp54793312-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#idp54795440-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#idp54797712-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> + <span class="identifier">size_type</span> <a class="link" href="cached_node_allocator.html#idp54799776-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#idp61926960-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idp61927520-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="cached_node_allocator.html#idp54811552-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="cached_node_allocator.html#idp54812112-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="idp252296352"></a><h2>Description</h2> +<a name="idp271147216"></a><h2>Description</h2> <div class="refsect2"> -<a name="idp252296768"></a><h3> +<a name="idp271147632"></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="idp61916912-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> +<pre class="literallayout"><a name="idp54801504-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> <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> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp61919184-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> +<pre class="literallayout"><a name="idp54803776-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 <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> </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="idp61921856-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> + <a name="idp54806448-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 <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> </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> <a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> <span class="special">&</span> - <a name="idp61858160-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> + <a name="idp54742752-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 <code class="computeroutput"><a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a></code> </p> </li> <li class="listitem"> -<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="idp61863616-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> +<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="idp54748208-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 <code class="computeroutput"><a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp61926176-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> +<pre class="literallayout"><a name="idp54810768-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="idp252362800"></a><h3> -<a name="idp61866800-bb"></a><code class="computeroutput">cached_node_allocator</code> public member functions</h3> +<a name="idp271213536"></a><h3> +<a name="idp54751392-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="idp61867360-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">node_pool_t</span> <span class="special">*</span> <a name="idp54751952-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a pointer to the node pool. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp61868928-bb"></a><span class="identifier">get_segment_manager</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp54753520-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="idp61870496-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54755088-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="idp61872080-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54756672-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocate memory for an array of count elements. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61875808-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54760400-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="idp61878480-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54763072-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="idp61879776-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54764368-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="idp61882032-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">const_reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idp54766624-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="idp61884288-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54768880-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="idp61886976-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54771568-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="idp61888960-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54773552-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">pointer</span> <a name="idp61891360-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> +<li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54775952-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> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">pointer</span> <span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61894992-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54779584-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">size_type</span> num_elements<span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&</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="keyword">void</span> <a name="idp61898624-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54783216-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<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="idp61902064-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54786656-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> <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="idp61904320-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54788912-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">multiallocation_chain</span> <a name="idp61906448-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">multiallocation_chain</span> <a name="idp54791040-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">)</span><span class="special">;</span></pre> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61908720-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54793312-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="idp61910848-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54795440-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="idp61913120-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54797712-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> <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">size_type</span> <a name="idp61915184-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> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54799776-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="idp252511344"></a><h3> -<a name="idp61926960-bb"></a><code class="computeroutput">cached_node_allocator</code> friend functions</h3> +<a name="idp271362016"></a><h3> +<a name="idp54811552-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="idp61927520-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp54812112-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> @@ -240,7 +240,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61831632.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> +<a accesskey="p" href="operator___idp54716224.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> </div> </body> </html> diff --git a/doc/html/boost/interprocess/cached_node_allocator/rebind.html b/doc/html/boost/interprocess/cached_node_allocator/rebind.html index 769bf1074e..a222c118e5 100644 --- a/doc/html/boost/interprocess/cached_node_allocator/rebind.html +++ b/doc/html/boost/interprocess/cached_node_allocator/rebind.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../cached_node_allocator.html#idp252296352" title="Description"> +<link rel="up" href="../cached_node_allocator.html#idp271147216" title="Description"> <link rel="prev" href="../cached_node_allocator.html" title="Class template cached_node_allocator"> -<link rel="next" href="../operator___idp61930576.html" title="Function template operator=="> +<link rel="next" href="../operator___idp54815168.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../cached_node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cached_node_allocator.html#idp252296352"><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="../operator___idp61930576.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../cached_node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cached_node_allocator.html#idp271147216"><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="../operator___idp54815168.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.cached_node_allocator.rebind"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <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 name="boost.interprocess.cached_node_allocator.rebind.other"></a><span class="identifier">other</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp252539392"></a><h2>Description</h2> +<a name="idp271390128"></a><h2>Description</h2> <p>Obtains <a class="link" href="../cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> from <a class="link" href="../cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a> </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../cached_node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cached_node_allocator.html#idp252296352"><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="../operator___idp61930576.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../cached_node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../cached_node_allocator.html#idp271147216"><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="../operator___idp54815168.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/create_only.html b/doc/html/boost/interprocess/create_only.html index 51cab9b5eb..ff332446d3 100644 --- a/doc/html/boost/interprocess/create_only.html +++ b/doc/html/boost/interprocess/create_only.html @@ -34,7 +34,7 @@ </span><span class="keyword">static</span> <span class="keyword">const</span> <a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254690960"></a><h2>Description</h2> +<a name="idp273541552"></a><h2>Description</h2> <p>Value to indicate that the resource must be only created </p> </div> </div> diff --git a/doc/html/boost/interprocess/create_only_t.html b/doc/html/boost/interprocess/create_only_t.html index 42f5687cd7..222d32c35c 100644 --- a/doc/html/boost/interprocess/create_only_t.html +++ b/doc/html/boost/interprocess/create_only_t.html @@ -36,7 +36,7 @@ <span class="keyword">struct</span> <a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> <span class="special">{</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254644080"></a><h2>Description</h2> +<a name="idp273494560"></a><h2>Description</h2> <p>Tag to indicate that the resource must be only created </p> </div> </div> diff --git a/doc/html/boost/interprocess/defer_lock.html b/doc/html/boost/interprocess/defer_lock.html index 9b3065d19e..17dbc4c6b0 100644 --- a/doc/html/boost/interprocess/defer_lock.html +++ b/doc/html/boost/interprocess/defer_lock.html @@ -34,7 +34,7 @@ </span><span class="keyword">static</span> <span class="keyword">const</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a> defer_lock<span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp265773632"></a><h2>Description</h2> +<a name="idp284626688"></a><h2>Description</h2> <p>An object indicating that the locking must be deferred. </p> </div> </div> diff --git a/doc/html/boost/interprocess/defer_lock_type.html b/doc/html/boost/interprocess/defer_lock_type.html index 8667a18791..6d060d6741 100644 --- a/doc/html/boost/interprocess/defer_lock_type.html +++ b/doc/html/boost/interprocess/defer_lock_type.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.lock_options_hpp" title="Header <boost/interprocess/sync/lock_options.hpp>"> -<link rel="prev" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex"> +<link rel="prev" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex"> <link rel="next" href="try_to_lock_type.html" title="Struct try_to_lock_type"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_u_idp64096208.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.lock_options_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="try_to_lock_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_u_idp56980800.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.lock_options_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="try_to_lock_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.defer_lock_type"></a><div class="titlepage"></div> @@ -46,7 +46,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_u_idp64096208.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.lock_options_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="try_to_lock_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_u_idp56980800.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.lock_options_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="try_to_lock_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/deleter.html b/doc/html/boost/interprocess/deleter.html index e191874bbc..19f4277ace 100644 --- a/doc/html/boost/interprocess/deleter.html +++ b/doc/html/boost/interprocess/deleter.html @@ -39,26 +39,26 @@ <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">intrusive</span><span class="special">::</span><span class="identifier">pointer_traits</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">SegmentManager</span><span class="special">::</span><span class="identifier">void_pointer</span> <span class="special">></span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">rebind_pointer</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="boost.interprocess.deleter.pointer"></a><span class="identifier">pointer</span><span class="special">;</span> <span class="comment">// <a class="link" href="deleter.html#boost.interprocess.deleterconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="deleter.html#idp63356528-bb"><span class="identifier">deleter</span></a><span class="special">(</span><span class="identifier">segment_manager_pointer</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="deleter.html#idp56241120-bb"><span class="identifier">deleter</span></a><span class="special">(</span><span class="identifier">segment_manager_pointer</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="deleter.html#idp63354272-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="deleter.html#idp63354832-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</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="comment">// <a class="link" href="deleter.html#idp56238864-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="deleter.html#idp56239424-bb"><span class="keyword">operator</span><span class="special">(</span><span class="special">)</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="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp260615440"></a><h2>Description</h2> +<a name="idp279466480"></a><h2>Description</h2> <p>A deleter that uses the segment manager's destroy_ptr function to destroy the passed pointer resource.</p> <p>This deleter is used </p> <div class="refsect2"> -<a name="idp260616512"></a><h3> +<a name="idp279467552"></a><h3> <a name="boost.interprocess.deleterconstruct-copy-destruct"></a><code class="computeroutput">deleter</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp63356528-bb"></a><span class="identifier">deleter</span><span class="special">(</span><span class="identifier">segment_manager_pointer</span> pmngr<span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp56241120-bb"></a><span class="identifier">deleter</span><span class="special">(</span><span class="identifier">segment_manager_pointer</span> pmngr<span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp260623104"></a><h3> -<a name="idp63354272-bb"></a><code class="computeroutput">deleter</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp63354832-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</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></li></ol></div> +<a name="idp279474016"></a><h3> +<a name="idp56238864-bb"></a><code class="computeroutput">deleter</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <a name="idp56239424-bb"></a><span class="keyword">operator</span><span class="special">(</span><span class="special">)</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></li></ol></div> </div> </div> </div> diff --git a/doc/html/boost/interprocess/enable_shared_from_this.html b/doc/html/boost/interprocess/enable_shared_from_this.html index c7174a7101..5a294fa25a 100644 --- a/doc/html/boost/interprocess/enable_shared_from_this.html +++ b/doc/html/boost/interprocess/enable_shared_from_this.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_hpp" title="Header <boost/interprocess/smart_ptr/shared_ptr.hpp>"> -<link rel="prev" href="to_raw_pointer_idp63491200.html" title="Function template to_raw_pointer"> +<link rel="prev" href="to_raw_pointer_idp56375792.html" title="Function template to_raw_pointer"> <link rel="next" href="shared_ptr.html" title="Class template shared_ptr"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="to_raw_pointer_idp63491200.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="shared_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="to_raw_pointer_idp56375792.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="shared_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.enable_shared_from_this"></a><div class="titlepage"></div> @@ -36,19 +36,19 @@ <span class="keyword">class</span> <a class="link" href="enable_shared_from_this.html" title="Class template enable_shared_from_this">enable_shared_from_this</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="enable_shared_from_this.html#idp63502144-bb">public member functions</a></span> - <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a class="link" href="enable_shared_from_this.html#idp63502704-bb"><span class="identifier">shared_from_this</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a class="link" href="enable_shared_from_this.html#idp63503840-bb"><span class="identifier">shared_from_this</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="enable_shared_from_this.html#idp56386736-bb">public member functions</a></span> + <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a class="link" href="enable_shared_from_this.html#idp56387296-bb"><span class="identifier">shared_from_this</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a class="link" href="enable_shared_from_this.html#idp56388432-bb"><span class="identifier">shared_from_this</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261917984"></a><h2>Description</h2> +<a name="idp280769056"></a><h2>Description</h2> <p>This class is used as a base class that allows a <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> to the current object to be obtained from within a member function. <a class="link" href="enable_shared_from_this.html" title="Class template enable_shared_from_this">enable_shared_from_this</a> defines two member functions called shared_from_this that return a shared_ptr<T> and shared_ptr<T const>, depending on constness, to this. </p> <div class="refsect2"> -<a name="idp261920736"></a><h3> -<a name="idp63502144-bb"></a><code class="computeroutput">enable_shared_from_this</code> public member functions</h3> +<a name="idp280771808"></a><h3> +<a name="idp56386736-bb"></a><code class="computeroutput">enable_shared_from_this</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a name="idp63502704-bb"></a><span class="identifier">shared_from_this</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a name="idp63503840-bb"></a><span class="identifier">shared_from_this</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a name="idp56387296-bb"></a><span class="identifier">shared_from_this</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span> <span class="keyword">const</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a name="idp56388432-bb"></a><span class="identifier">shared_from_this</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> </ol></div> </div> </div> @@ -63,7 +63,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="to_raw_pointer_idp63491200.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="shared_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="to_raw_pointer_idp56375792.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="shared_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/file_lock.html b/doc/html/boost/interprocess/file_lock.html index 1797715e74..bd1258a3d8 100644 --- a/doc/html/boost/interprocess/file_lock.html +++ b/doc/html/boost/interprocess/file_lock.html @@ -36,90 +36,90 @@ <span class="keyword">class</span> <a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="file_lock.html#boost.interprocess.file_lockconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="file_lock.html#idp63933264-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="file_lock.html#idp63934000-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="file_lock.html#idp63936224-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&</span> <a class="link" href="file_lock.html#idp63938032-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="file_lock.html#idp63940400-bb"><span class="special">~</span><span class="identifier">file_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_lock.html#idp56817856-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_lock.html#idp56818592-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_lock.html#idp56820816-bb"><span class="identifier">file_lock</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&</span> <a class="link" href="file_lock.html#idp56822624-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_lock.html#idp56824992-bb"><span class="special">~</span><span class="identifier">file_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="file_lock.html#idp63911008-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="file_lock.html#idp63911568-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="file_lock.html#idp63913824-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp63916032-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp63918320-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="file_lock.html#idp63921312-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="file_lock.html#idp63923488-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp63925680-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp63927952-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="file_lock.html#idp63930928-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="file_lock.html#idp56795600-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="file_lock.html#idp56796160-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="file_lock.html#idp56798416-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp56800624-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp56802912-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="file_lock.html#idp56805904-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="file_lock.html#idp56808080-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp56810272-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="file_lock.html#idp56812544-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="file_lock.html#idp56815520-bb"><span class="identifier">unlock_sharable</span></a><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="idp264541568"></a><h2>Description</h2> +<a name="idp283393456"></a><h2>Description</h2> <p>A file lock, is a mutual exclusion utility similar to a mutex using a file. A file lock has sharable and exclusive locking capabilities and can be used with <a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> and <a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> classes. A file lock can't guarantee synchronization between threads of the same process so just use file locks to synchronize threads from different processes. </p> <div class="refsect2"> -<a name="idp264544336"></a><h3> +<a name="idp283396224"></a><h3> <a name="boost.interprocess.file_lockconstruct-copy-destruct"></a><code class="computeroutput">file_lock</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63933264-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56817856-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs an empty file mapping. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63934000-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56818592-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Opens a file lock. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if the file does not exist or there are no operating system resources. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63936224-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56820816-bb"></a><span class="identifier">file_lock</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s file mapping object to *this. After the call, "moved" does not represent any file mapping object. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&</span> <a name="idp63938032-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&</span> <a name="idp56822624-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s file mapping to *this. After the call, "moved" does not represent any file mapping. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63940400-bb"></a><span class="special">~</span><span class="identifier">file_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Closes a file lock. Does not throw. </li> +<pre class="literallayout"><a name="idp56824992-bb"></a><span class="special">~</span><span class="identifier">file_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Closes a file lock. Does not throw. </li> </ol></div> </div> <div class="refsect2"> -<a name="idp264575216"></a><h3> -<a name="idp63911008-bb"></a><code class="computeroutput">file_lock</code> public member functions</h3> +<a name="idp283427120"></a><h3> +<a name="idp56795600-bb"></a><code class="computeroutput">file_lock</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63911568-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56796160-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="file_lock.html" title="Class file_lock">file_lock</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Swaps two file_locks. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63913824-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56798416-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, or sharable ownership of the mutex, it waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63916032-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56800624-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive, or sharable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63918320-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56802912-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, or sharable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63921312-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56805904-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63923488-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56808080-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63925680-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56810272-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63927952-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56812544-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63930928-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56815520-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/file_mapping.html b/doc/html/boost/interprocess/file_mapping.html index 788b14ff87..34d3a0c54a 100644 --- a/doc/html/boost/interprocess/file_mapping.html +++ b/doc/html/boost/interprocess/file_mapping.html @@ -36,79 +36,79 @@ <span class="keyword">class</span> <a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="file_mapping.html#boost.interprocess.file_mappingconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="file_mapping.html#idp62367520-bb"><span class="identifier">file_mapping</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="file_mapping.html#idp62368256-bb"><span class="identifier">file_mapping</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="file_mapping.html#idp62371280-bb"><span class="identifier">file_mapping</span></a><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&</span> <a class="link" href="file_mapping.html#idp62373088-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="file_mapping.html#idp62375456-bb"><span class="special">~</span><span class="identifier">file_mapping</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_mapping.html#idp55252112-bb"><span class="identifier">file_mapping</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_mapping.html#idp55252848-bb"><span class="identifier">file_mapping</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_mapping.html#idp55255872-bb"><span class="identifier">file_mapping</span></a><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&</span> <a class="link" href="file_mapping.html#idp55257680-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="file_mapping.html#idp55260048-bb"><span class="special">~</span><span class="identifier">file_mapping</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="file_mapping.html#idp62359088-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="file_mapping.html#idp62359648-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">mode_t</span> <a class="link" href="file_mapping.html#idp62361920-bb"><span class="identifier">get_mode</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mapping_handle_t</span> <a class="link" href="file_mapping.html#idp62363488-bb"><span class="identifier">get_mapping_handle</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="file_mapping.html#idp62365792-bb"><span class="identifier">get_name</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="file_mapping.html#idp55243680-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="file_mapping.html#idp55244240-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">mode_t</span> <a class="link" href="file_mapping.html#idp55246512-bb"><span class="identifier">get_mode</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mapping_handle_t</span> <a class="link" href="file_mapping.html#idp55248080-bb"><span class="identifier">get_mapping_handle</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="file_mapping.html#idp55250384-bb"><span class="identifier">get_name</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="file_mapping.html#idp62376240-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="file_mapping.html#idp62376800-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="file_mapping.html#idp55260832-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="file_mapping.html#idp55261392-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp254992368"></a><h2>Description</h2> +<a name="idp273842816"></a><h2>Description</h2> <p>A class that wraps a file-mapping that can be used to create mapped regions from the mapped files </p> <div class="refsect2"> -<a name="idp254993152"></a><h3> +<a name="idp273843600"></a><h3> <a name="boost.interprocess.file_mappingconstruct-copy-destruct"></a><code class="computeroutput">file_mapping</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62367520-bb"></a><span class="identifier">file_mapping</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55252112-bb"></a><span class="identifier">file_mapping</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs an empty file mapping. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62368256-bb"></a><span class="identifier">file_mapping</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55252848-bb"></a><span class="identifier">file_mapping</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">)</span><span class="special">;</span></pre> <p>Opens a file mapping of file "filename", starting in offset "file_offset", and the mapping's size will be "size". The mapping can be opened for read-only "read_only" or read-write "read_write" modes. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62371280-bb"></a><span class="identifier">file_mapping</span><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55255872-bb"></a><span class="identifier">file_mapping</span><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s file mapping object to *this. After the call, "moved" does not represent any file mapping object. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&</span> <a name="idp62373088-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&</span> <a name="idp55257680-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s file mapping to *this. After the call, "moved" does not represent any file mapping. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62375456-bb"></a><span class="special">~</span><span class="identifier">file_mapping</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55260048-bb"></a><span class="special">~</span><span class="identifier">file_mapping</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys the file mapping. All mapped regions created from this are still valid. Does not throw </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp255026000"></a><h3> -<a name="idp62359088-bb"></a><code class="computeroutput">file_mapping</code> public member functions</h3> +<a name="idp273876256"></a><h3> +<a name="idp55243680-bb"></a><code class="computeroutput">file_mapping</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62359648-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55244240-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="file_mapping.html" title="Class file_mapping">file_mapping</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Swaps to file_mappings. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mode_t</span> <a name="idp62361920-bb"></a><span class="identifier">get_mode</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mode_t</span> <a name="idp55246512-bb"></a><span class="identifier">get_mode</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns access mode used in the constructor </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idp62363488-bb"></a><span class="identifier">get_mapping_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idp55248080-bb"></a><span class="identifier">get_mapping_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Obtains the mapping handle to be used with <code class="computeroutput"><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp62365792-bb"></a><span class="identifier">get_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp55250384-bb"></a><span class="identifier">get_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the name of the file used in the constructor. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp255052784"></a><h3> -<a name="idp62376240-bb"></a><code class="computeroutput">file_mapping</code> public static functions</h3> +<a name="idp273902976"></a><h3> +<a name="idp55260832-bb"></a><code class="computeroutput">file_mapping</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp62376800-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp55261392-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> filename<span class="special">)</span><span class="special">;</span></pre> <p>Removes the file named "filename" even if it's been memory mapped. Returns true on success. The function might fail in some operating systems if the file is being used other processes and no deletion permission was shared. </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/fixed_managed__idp62762848.html b/doc/html/boost/interprocess/fixed_managed__idp55647440.html index a692b1514a..9c5c9fdd99 100644 --- a/doc/html/boost/interprocess/fixed_managed__idp62762848.html +++ b/doc/html/boost/interprocess/fixed_managed__idp55647440.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_hpp" title="Header <boost/interprocess/managed_shared_memory.hpp>"> <link rel="prev" href="wmanaged_shared_memory.html" title="Type definition wmanaged_shared_memory"> -<link rel="next" href="wfixed_managed_idp62766576.html" title="Type definition wfixed_managed_shared_memory"> +<link rel="next" href="wfixed_managed_idp55651168.html" title="Type definition wfixed_managed_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="wmanaged_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="wfixed_managed_idp62766576.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="wmanaged_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="wfixed_managed_idp55651168.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.fixed_managed__idp62762848"></a><div class="titlepage"></div> +<a name="boost.interprocess.fixed_managed__idp55647440"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Type definition fixed_managed_shared_memory</span></h2> <p>fixed_managed_shared_memory</p> @@ -33,10 +33,10 @@ <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.managed_shared_memory_hpp" title="Header <boost/interprocess/managed_shared_memory.hpp>">boost/interprocess/managed_shared_memory.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">fixed_managed_shared_memory</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">fixed_managed_shared_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257117504"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> of narrow characters to be placed in a fixed address </p> +<a name="idp275967568"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> of narrow characters to be placed in a fixed address </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="wmanaged_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="wfixed_managed_idp62766576.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="wmanaged_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="wfixed_managed_idp55651168.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/flat_map_index.html b/doc/html/boost/interprocess/flat_map_index.html index 093287f8db..954c6a9a4c 100644 --- a/doc/html/boost/interprocess/flat_map_index.html +++ b/doc/html/boost/interprocess/flat_map_index.html @@ -36,31 +36,31 @@ <span class="keyword">class</span> <a class="link" href="flat_map_index.html" title="Class template flat_map_index">flat_map_index</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">flat_map_index_aux</span><span class="special">::</span><span class="identifier">index_t</span><span class="special"><</span> <span class="identifier">MapConfig</span> <span class="special">></span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="flat_map_index.html#boost.interprocess.flat_map_indexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="flat_map_index.html#idp62388272-bb"><span class="identifier">flat_map_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="flat_map_index.html#idp55272864-bb"><span class="identifier">flat_map_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="flat_map_index.html#idp62384480-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="flat_map_index.html#idp62385040-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</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="flat_map_index.html#idp62386960-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="flat_map_index.html#idp55269072-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="flat_map_index.html#idp55269632-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</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="flat_map_index.html#idp55271552-bb"><span class="identifier">shrink_to_fit</span></a><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="idp255107952"></a><h2>Description</h2> +<a name="idp273958320"></a><h2>Description</h2> <p>Index type based in flat_map. Just derives from flat_map and defines the interface needed by managed memory segments. </p> <div class="refsect2"> -<a name="idp255108752"></a><h3> +<a name="idp273959120"></a><h3> <a name="boost.interprocess.flat_map_indexconstruct-copy-destruct"></a><code class="computeroutput">flat_map_index</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp62388272-bb"></a><span class="identifier">flat_map_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre>Constructor. Takes a pointer to the segment manager. Can throw. </li></ol></div> +<pre class="literallayout"><a name="idp55272864-bb"></a><span class="identifier">flat_map_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre>Constructor. Takes a pointer to the segment manager. Can throw. </li></ol></div> </div> <div class="refsect2"> -<a name="idp255116352"></a><h3> -<a name="idp62384480-bb"></a><code class="computeroutput">flat_map_index</code> public member functions</h3> +<a name="idp273966800"></a><h3> +<a name="idp55269072-bb"></a><code class="computeroutput">flat_map_index</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62385040-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre>This reserves memory to optimize the insertion of n elements in the index. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55269632-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre>This reserves memory to optimize the insertion of n elements in the index. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62386960-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>This frees all unnecessary memory. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55271552-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>This frees all unnecessary memory. </li> </ol></div> </div> </div> diff --git a/doc/html/boost/interprocess/interprocess_condition.html b/doc/html/boost/interprocess/interprocess_condition.html index cfddd3363d..e00bdf2a3e 100644 --- a/doc/html/boost/interprocess/interprocess_condition.html +++ b/doc/html/boost/interprocess/interprocess_condition.html @@ -36,64 +36,64 @@ <span class="keyword">class</span> <a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="interprocess_condition.html#boost.interprocess.interprocess_conditionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="interprocess_condition.html#idp63965696-bb"><span class="identifier">interprocess_condition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_condition.html#idp63967776-bb"><span class="special">~</span><span class="identifier">interprocess_condition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_condition.html#idp56850288-bb"><span class="identifier">interprocess_condition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_condition.html#idp56852368-bb"><span class="special">~</span><span class="identifier">interprocess_condition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="interprocess_condition.html#idp63945120-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idp63945680-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idp63947040-bb"><span class="identifier">notify_all</span></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> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idp63948416-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idp63952128-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="interprocess_condition.html#idp63956208-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_condition.html#idp56829712-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idp56830272-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idp56831632-bb"><span class="identifier">notify_all</span></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> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idp56833008-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition.html#idp56836720-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="interprocess_condition.html#idp56840800-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> - <span class="keyword">bool</span> <a class="link" href="interprocess_condition.html#idp63960704-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_condition.html#idp56845296-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp264720160"></a><h2>Description</h2> +<a name="idp283572304"></a><h2>Description</h2> <p>This class is a condition variable that can be placed in shared memory or memory mapped files. Destroys the object of type std::condition_variable_any</p> <p>Unlike std::condition_variable in C++11, it is NOT safe to invoke the destructor if all threads have been only notified. It is required that they have exited their respective wait functions. </p> <div class="refsect2"> -<a name="idp264721456"></a><h3> +<a name="idp283573600"></a><h3> <a name="boost.interprocess.interprocess_conditionconstruct-copy-destruct"></a><code class="computeroutput">interprocess_condition</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63965696-bb"></a><span class="identifier">interprocess_condition</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Constructs a <code class="computeroutput"><a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a></code>. On error throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </li> +<pre class="literallayout"><a name="idp56850288-bb"></a><span class="identifier">interprocess_condition</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Constructs a <code class="computeroutput"><a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a></code>. On error throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63967776-bb"></a><span class="special">~</span><span class="identifier">interprocess_condition</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56852368-bb"></a><span class="special">~</span><span class="identifier">interprocess_condition</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this liberating system resources. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp264734576"></a><h3> -<a name="idp63945120-bb"></a><code class="computeroutput">interprocess_condition</code> public member functions</h3> +<a name="idp283586656"></a><h3> +<a name="idp56829712-bb"></a><code class="computeroutput">interprocess_condition</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63945680-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56830272-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63947040-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56831632-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="idp63948416-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="idp56833008-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">)</span><span class="special">;</span></pre> <p>Releases the lock on the <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), and then reacquires the lock. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a name="idp63952128-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a name="idp56836720-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> <p>The same as: while (!pred()) wait(lock) </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> - <span class="keyword">bool</span> <a name="idp63956208-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> + <span class="keyword">bool</span> <a name="idp56840800-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Releases the lock on the <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), or until time abs_time is reached, and then reacquires the lock. Returns: false if time abs_time is reached, otherwise true. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> - <span class="keyword">bool</span> <a name="idp63960704-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">,</span> + <span class="keyword">bool</span> <a name="idp56845296-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> <p>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </p> </li> diff --git a/doc/html/boost/interprocess/interprocess_condition_any.html b/doc/html/boost/interprocess/interprocess_condition_any.html index 292424c26f..a7aee2ba50 100644 --- a/doc/html/boost/interprocess/interprocess_condition_any.html +++ b/doc/html/boost/interprocess/interprocess_condition_any.html @@ -36,65 +36,65 @@ <span class="keyword">class</span> <a class="link" href="interprocess_condition_any.html" title="Class interprocess_condition_any">interprocess_condition_any</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="interprocess_condition_any.html#boost.interprocess.interprocess_condition_anyconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="interprocess_condition_any.html#idp63997392-bb"><span class="identifier">interprocess_condition_any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_condition_any.html#idp63999488-bb"><span class="special">~</span><span class="identifier">interprocess_condition_any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_condition_any.html#idp56881984-bb"><span class="identifier">interprocess_condition_any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_condition_any.html#idp56884080-bb"><span class="special">~</span><span class="identifier">interprocess_condition_any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="interprocess_condition_any.html#idp63976816-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp63977376-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp63978736-bb"><span class="identifier">notify_all</span></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> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp63980112-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp63983824-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="interprocess_condition_any.html#idp63987904-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_condition_any.html#idp56861408-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp56861968-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp56863328-bb"><span class="identifier">notify_all</span></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> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp56864704-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a class="link" href="interprocess_condition_any.html#idp56868416-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="interprocess_condition_any.html#idp56872496-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> - <span class="keyword">bool</span> <a class="link" href="interprocess_condition_any.html#idp63992400-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_condition_any.html#idp56876992-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp264877760"></a><h2>Description</h2> +<a name="idp283729968"></a><h2>Description</h2> <p>This class is a condition variable that can be placed in shared memory or memory mapped files.</p> <p>The <a class="link" href="interprocess_condition_any.html" title="Class interprocess_condition_any">interprocess_condition_any</a> class is a generalization of <a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a>. Whereas <a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a> works only on Locks with mutex_type == <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> <a class="link" href="interprocess_condition_any.html" title="Class interprocess_condition_any">interprocess_condition_any</a> can operate on any user-defined lock that meets the BasicLockable requirements (lock()/unlock() member functions).</p> <p>Unlike std::condition_variable_any in C++11, it is NOT safe to invoke the destructor if all threads have been only notified. It is required that they have exited their respective wait functions. </p> <div class="refsect2"> -<a name="idp264883952"></a><h3> +<a name="idp283736160"></a><h3> <a name="boost.interprocess.interprocess_condition_anyconstruct-copy-destruct"></a><code class="computeroutput">interprocess_condition_any</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63997392-bb"></a><span class="identifier">interprocess_condition_any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Constructs a <code class="computeroutput"><a class="link" href="interprocess_condition_any.html" title="Class interprocess_condition_any">interprocess_condition_any</a></code>. On error throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </li> +<pre class="literallayout"><a name="idp56881984-bb"></a><span class="identifier">interprocess_condition_any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Constructs a <code class="computeroutput"><a class="link" href="interprocess_condition_any.html" title="Class interprocess_condition_any">interprocess_condition_any</a></code>. On error throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63999488-bb"></a><span class="special">~</span><span class="identifier">interprocess_condition_any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56884080-bb"></a><span class="special">~</span><span class="identifier">interprocess_condition_any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this liberating system resources. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp264897072"></a><h3> -<a name="idp63976816-bb"></a><code class="computeroutput">interprocess_condition_any</code> public member functions</h3> +<a name="idp283749344"></a><h3> +<a name="idp56861408-bb"></a><code class="computeroutput">interprocess_condition_any</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63977376-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56861968-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63978736-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56863328-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="idp63980112-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="idp56864704-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">)</span><span class="special">;</span></pre> <p>Releases the lock on the <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), and then reacquires the lock. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a name="idp63983824-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a name="idp56868416-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> <p>The same as: while (!pred()) wait(lock) </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> - <span class="keyword">bool</span> <a name="idp63987904-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> + <span class="keyword">bool</span> <a name="idp56872496-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Releases the lock on the <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), or until time abs_time is reached, and then reacquires the lock. Returns: false if time abs_time is reached, otherwise true. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> - <span class="keyword">bool</span> <a name="idp63992400-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">,</span> + <span class="keyword">bool</span> <a name="idp56876992-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> <p>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </p> </li> diff --git a/doc/html/boost/interprocess/interprocess_exception.html b/doc/html/boost/interprocess/interprocess_exception.html index a8ac12e039..6bcc7241f8 100644 --- a/doc/html/boost/interprocess/interprocess_exception.html +++ b/doc/html/boost/interprocess/interprocess_exception.html @@ -36,36 +36,36 @@ <span class="keyword">class</span> <a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">exception</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="interprocess_exception.html#boost.interprocess.interprocess_exceptionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="interprocess_exception.html#idp62342336-bb"><span class="identifier">interprocess_exception</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_exception.html#idp62343312-bb"><span class="identifier">interprocess_exception</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">error_info</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_exception.html#idp62345264-bb"><span class="special">~</span><span class="identifier">interprocess_exception</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_exception.html#idp55226928-bb"><span class="identifier">interprocess_exception</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_exception.html#idp55227904-bb"><span class="identifier">interprocess_exception</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">error_info</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_exception.html#idp55229856-bb"><span class="special">~</span><span class="identifier">interprocess_exception</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="interprocess_exception.html#idp62337984-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="interprocess_exception.html#idp62338544-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">native_error_t</span> <a class="link" href="interprocess_exception.html#idp62339936-bb"><span class="identifier">get_native_error</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">error_code_t</span> <a class="link" href="interprocess_exception.html#idp62341056-bb"><span class="identifier">get_error_code</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="interprocess_exception.html#idp55222576-bb">public member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="interprocess_exception.html#idp55223136-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">native_error_t</span> <a class="link" href="interprocess_exception.html#idp55224528-bb"><span class="identifier">get_native_error</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">error_code_t</span> <a class="link" href="interprocess_exception.html#idp55225648-bb"><span class="identifier">get_error_code</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254795584"></a><h2>Description</h2> +<a name="idp273646032"></a><h2>Description</h2> <p>This class is the base class of all exceptions thrown by boost::interprocess </p> <div class="refsect2"> -<a name="idp254796352"></a><h3> +<a name="idp273646800"></a><h3> <a name="boost.interprocess.interprocess_exceptionconstruct-copy-destruct"></a><code class="computeroutput">interprocess_exception</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp62342336-bb"></a><span class="identifier">interprocess_exception</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> err<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><a name="idp62343312-bb"></a><span class="identifier">interprocess_exception</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">error_info</span> <span class="special">&</span> err_info<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> str <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"><a name="idp62345264-bb"></a><span class="special">~</span><span class="identifier">interprocess_exception</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp55226928-bb"></a><span class="identifier">interprocess_exception</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> err<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp55227904-bb"></a><span class="identifier">interprocess_exception</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">error_info</span> <span class="special">&</span> err_info<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> str <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"><a name="idp55229856-bb"></a><span class="special">~</span><span class="identifier">interprocess_exception</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp254818048"></a><h3> -<a name="idp62337984-bb"></a><code class="computeroutput">interprocess_exception</code> public member functions</h3> +<a name="idp273668496"></a><h3> +<a name="idp55222576-bb"></a><code class="computeroutput">interprocess_exception</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp62338544-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="identifier">native_error_t</span> <a name="idp62339936-bb"></a><span class="identifier">get_native_error</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="identifier">error_code_t</span> <a name="idp62341056-bb"></a><span class="identifier">get_error_code</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp55223136-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">native_error_t</span> <a name="idp55224528-bb"></a><span class="identifier">get_native_error</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">error_code_t</span> <a name="idp55225648-bb"></a><span class="identifier">get_error_code</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> </ol></div> </div> </div> diff --git a/doc/html/boost/interprocess/interprocess_mutex.html b/doc/html/boost/interprocess/interprocess_mutex.html index 929e1366ed..76599f6e62 100644 --- a/doc/html/boost/interprocess/interprocess_mutex.html +++ b/doc/html/boost/interprocess/interprocess_mutex.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_mutex_hpp" title="Header <boost/interprocess/sync/interprocess_mutex.hpp>"> <link rel="prev" href="interprocess_condition_any.html" title="Class interprocess_condition_any"> -<link rel="next" href="interprocess_r_idp64020000.html" title="Class interprocess_recursive_mutex"> +<link rel="next" href="interprocess_r_idp56904592.html" title="Class interprocess_recursive_mutex"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_condition_any.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_mutex_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="interprocess_r_idp64020000.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_condition_any.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_mutex_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="interprocess_r_idp56904592.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.interprocess_mutex"></a><div class="titlepage"></div> @@ -36,52 +36,52 @@ <span class="keyword">class</span> <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="interprocess_mutex.html#boost.interprocess.interprocess_mutexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="interprocess_mutex.html#idp64014992-bb"><span class="identifier">interprocess_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_mutex.html#idp64016448-bb"><span class="special">~</span><span class="identifier">interprocess_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_mutex.html#idp56899584-bb"><span class="identifier">interprocess_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_mutex.html#idp56901040-bb"><span class="special">~</span><span class="identifier">interprocess_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="interprocess_mutex.html#idp64004592-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_mutex.html#idp64005152-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_mutex.html#idp64007408-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_mutex.html#idp64009696-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_mutex.html#idp64012752-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_mutex.html#idp56889184-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_mutex.html#idp56889744-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_mutex.html#idp56892000-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_mutex.html#idp56894288-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_mutex.html#idp56897344-bb"><span class="identifier">unlock</span></a><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="idp265007312"></a><h2>Description</h2> +<a name="idp283859984"></a><h2>Description</h2> <p>Wraps a <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </p> <div class="refsect2"> -<a name="idp265009008"></a><h3> +<a name="idp283861680"></a><h3> <a name="boost.interprocess.interprocess_mutexconstruct-copy-destruct"></a><code class="computeroutput">interprocess_mutex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64014992-bb"></a><span class="identifier">interprocess_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56899584-bb"></a><span class="identifier">interprocess_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64016448-bb"></a><span class="special">~</span><span class="identifier">interprocess_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56901040-bb"></a><span class="special">~</span><span class="identifier">interprocess_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destructor. If any process uses the mutex after the destructor is called the result is undefined. Does not throw. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp265021072"></a><h3> -<a name="idp64004592-bb"></a><code class="computeroutput">interprocess_mutex</code> public member functions</h3> +<a name="idp283873728"></a><h3> +<a name="idp56889184-bb"></a><code class="computeroutput">interprocess_mutex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64005152-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56889744-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex, it waits until it can obtain the ownership. If a thread takes ownership of the mutex the mutex must be unlocked by the same mutex. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64007408-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56892000-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex returns immediately. Returns: If the thread acquires ownership of the mutex, returns true, if the another thread has ownership of the mutex, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64009696-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56894288-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread will try to obtain exclusive ownership of the mutex if it can do so in until the specified time is reached. If the mutex supports recursive locking, the mutex must be unlocked the same number of times it is locked. Returns: If the thread acquires ownership of the mutex, returns true, if the timeout expires returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64012752-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56897344-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread releases the exclusive ownership of the mutex. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> </ol></div> @@ -98,7 +98,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_condition_any.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_mutex_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="interprocess_r_idp64020000.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_condition_any.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_mutex_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="interprocess_r_idp56904592.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/interprocess_r_idp64020000.html b/doc/html/boost/interprocess/interprocess_r_idp56904592.html index 0962be483e..3700d0b647 100644 --- a/doc/html/boost/interprocess/interprocess_r_idp64020000.html +++ b/doc/html/boost/interprocess/interprocess_r_idp56904592.html @@ -24,7 +24,7 @@ <a accesskey="p" href="interprocess_mutex.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_recursive_mutex_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="interprocess_semaphore.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.interprocess_r_idp64020000"></a><div class="titlepage"></div> +<a name="boost.interprocess.interprocess_r_idp56904592"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class interprocess_recursive_mutex</span></h2> <p>boost::interprocess::interprocess_recursive_mutex</p> @@ -33,55 +33,55 @@ <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.sync.interprocess_recursive_mutex_hpp" title="Header <boost/interprocess/sync/interprocess_recursive_mutex.hpp>">boost/interprocess/sync/interprocess_recursive_mutex.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="interprocess_r_idp64020000.html" title="Class interprocess_recursive_mutex">interprocess_recursive_mutex</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="interprocess_r_idp56904592.html" title="Class interprocess_recursive_mutex">interprocess_recursive_mutex</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="interprocess_r_idp64020000.html#boost.interprocess.interprocess_r_idp64020000construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="interprocess_r_idp64020000.html#idp64034864-bb"><span class="identifier">interprocess_recursive_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_r_idp64020000.html#idp64036320-bb"><span class="special">~</span><span class="identifier">interprocess_recursive_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_r_idp56904592.html#boost.interprocess.interprocess_r_idp56904592construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="interprocess_r_idp56904592.html#idp56919456-bb"><span class="identifier">interprocess_recursive_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_r_idp56904592.html#idp56920912-bb"><span class="special">~</span><span class="identifier">interprocess_recursive_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="interprocess_r_idp64020000.html#idp64021696-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_r_idp64020000.html#idp64022256-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_r_idp64020000.html#idp64024576-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_r_idp64020000.html#idp64028192-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_r_idp64020000.html#idp64032512-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_r_idp56904592.html#idp56906288-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_r_idp56904592.html#idp56906848-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_r_idp56904592.html#idp56909168-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_r_idp56904592.html#idp56912784-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_r_idp56904592.html#idp56917104-bb"><span class="identifier">unlock</span></a><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="idp265098848"></a><h2>Description</h2> +<a name="idp283951472"></a><h2>Description</h2> <p>Wraps a <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> that can be placed in shared memory and can be shared between processes. Allows several locking calls by the same process. Allows timed lock tries </p> <div class="refsect2"> -<a name="idp265100592"></a><h3> -<a name="boost.interprocess.interprocess_r_idp64020000construct-copy-destruct"></a><code class="computeroutput">interprocess_recursive_mutex</code> +<a name="idp283953216"></a><h3> +<a name="boost.interprocess.interprocess_r_idp56904592construct-copy-destruct"></a><code class="computeroutput">interprocess_recursive_mutex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64034864-bb"></a><span class="identifier">interprocess_recursive_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56919456-bb"></a><span class="identifier">interprocess_recursive_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64036320-bb"></a><span class="special">~</span><span class="identifier">interprocess_recursive_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56920912-bb"></a><span class="special">~</span><span class="identifier">interprocess_recursive_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destructor. If any process uses the mutex after the destructor is called the result is undefined. Does not throw. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp265112496"></a><h3> -<a name="idp64021696-bb"></a><code class="computeroutput">interprocess_recursive_mutex</code> public member functions</h3> +<a name="idp283965328"></a><h3> +<a name="idp56906288-bb"></a><code class="computeroutput">interprocess_recursive_mutex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64022256-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56906848-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain ownership of the mutex, and if another thread has ownership of the mutex, it waits until it can obtain the ownership. If a thread takes ownership of the mutex the mutex must be unlocked by the same mutex. The mutex must be unlocked the same number of times it is locked. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64024576-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56909168-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Tries to lock the <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code>, returns false when <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code> is already locked, returns true when success. The mutex must be unlocked the same number of times it is locked. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if a severe error is found </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64028192-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56912784-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Tries to lock the <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code>, if <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code> can't be locked before abs_time time, returns false. The mutex must be unlocked the same number of times it is locked. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if a severe error is found </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64032512-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56917104-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread releases the exclusive ownership of the mutex. If the mutex supports recursive locking, the mutex must be unlocked the same number of times it is locked. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/interprocess_s_idp64065392.html b/doc/html/boost/interprocess/interprocess_s_idp56949984.html index 15d20a662e..57832a163f 100644 --- a/doc/html/boost/interprocess/interprocess_s_idp64065392.html +++ b/doc/html/boost/interprocess/interprocess_s_idp56949984.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_sharable_mutex_hpp" title="Header <boost/interprocess/sync/interprocess_sharable_mutex.hpp>"> <link rel="prev" href="interprocess_semaphore.html" title="Class interprocess_semaphore"> -<link rel="next" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex"> +<link rel="next" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_semaphore.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_sharable_mutex_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="interprocess_u_idp64096208.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_semaphore.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_sharable_mutex_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="interprocess_u_idp56980800.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.interprocess_s_idp64065392"></a><div class="titlepage"></div> +<a name="boost.interprocess.interprocess_s_idp56949984"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class interprocess_sharable_mutex</span></h2> <p>boost::interprocess::interprocess_sharable_mutex</p> @@ -33,79 +33,79 @@ <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.sync.interprocess_sharable_mutex_hpp" title="Header <boost/interprocess/sync/interprocess_sharable_mutex.hpp>">boost/interprocess/sync/interprocess_sharable_mutex.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="interprocess_s_idp64065392.html#boost.interprocess.interprocess_s_idp64065392construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="interprocess_s_idp64065392.html#idp64067808-bb"><span class="identifier">interprocess_sharable_mutex</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_s_idp64065392.html#idp64091280-bb"><span class="identifier">interprocess_sharable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span> <a class="link" href="interprocess_s_idp64065392.html#idp64069248-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_s_idp64065392.html#idp64092752-bb"><span class="special">~</span><span class="identifier">interprocess_sharable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_s_idp56949984.html#boost.interprocess.interprocess_s_idp56949984construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="interprocess_s_idp56949984.html#idp56952400-bb"><span class="identifier">interprocess_sharable_mutex</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_s_idp56949984.html#idp56975872-bb"><span class="identifier">interprocess_sharable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span> <a class="link" href="interprocess_s_idp56949984.html#idp56953840-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_s_idp56949984.html#idp56977344-bb"><span class="special">~</span><span class="identifier">interprocess_sharable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="interprocess_s_idp64065392.html#idp64071280-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_s_idp64065392.html#idp64071840-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_s_idp64065392.html#idp64074048-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_s_idp64065392.html#idp64076336-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_s_idp64065392.html#idp64079328-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_s_idp64065392.html#idp64081504-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_s_idp64065392.html#idp64083696-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_s_idp64065392.html#idp64085968-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_s_idp64065392.html#idp64088944-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_s_idp56949984.html#idp56955872-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_s_idp56949984.html#idp56956432-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_s_idp56949984.html#idp56958640-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_s_idp56949984.html#idp56960928-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_s_idp56949984.html#idp56963920-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_s_idp56949984.html#idp56966096-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_s_idp56949984.html#idp56968288-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_s_idp56949984.html#idp56970560-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_s_idp56949984.html#idp56973536-bb"><span class="identifier">unlock_sharable</span></a><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="idp265333232"></a><h2>Description</h2> -<p>Wraps a <a class="link" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </p> +<a name="idp284186496"></a><h2>Description</h2> +<p>Wraps a <a class="link" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </p> <div class="refsect2"> -<a name="idp265334992"></a><h3> -<a name="boost.interprocess.interprocess_s_idp64065392construct-copy-destruct"></a><code class="computeroutput">interprocess_sharable_mutex</code> +<a name="idp284188256"></a><h3> +<a name="boost.interprocess.interprocess_s_idp56949984construct-copy-destruct"></a><code class="computeroutput">interprocess_sharable_mutex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp64067808-bb"></a><span class="identifier">interprocess_sharable_mutex</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp56952400-bb"></a><span class="identifier">interprocess_sharable_mutex</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><a name="idp64091280-bb"></a><span class="identifier">interprocess_sharable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56975872-bb"></a><span class="identifier">interprocess_sharable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs the sharable lock. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> -<li class="listitem"><pre class="literallayout"><a class="link" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span> <a name="idp64069248-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span> <a name="idp56953840-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex">interprocess_sharable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><a name="idp64092752-bb"></a><span class="special">~</span><span class="identifier">interprocess_sharable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56977344-bb"></a><span class="special">~</span><span class="identifier">interprocess_sharable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys the sharable lock. Does not throw. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp265360336"></a><h3> -<a name="idp64071280-bb"></a><code class="computeroutput">interprocess_sharable_mutex</code> public member functions</h3> +<a name="idp284213792"></a><h3> +<a name="idp56955872-bb"></a><code class="computeroutput">interprocess_sharable_mutex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64071840-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56956432-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive or sharable ownership of the mutex, it waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64074048-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56958640-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive or sharable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64076336-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56960928-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive or sharable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64079328-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56963920-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64081504-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56966096-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64083696-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56968288-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64085968-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56970560-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64088944-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56973536-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> </ol></div> @@ -122,7 +122,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_semaphore.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_sharable_mutex_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="interprocess_u_idp64096208.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_semaphore.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_sharable_mutex_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="interprocess_u_idp56980800.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/interprocess_semaphore.html b/doc/html/boost/interprocess/interprocess_semaphore.html index 154cecd999..0e5daeda65 100644 --- a/doc/html/boost/interprocess/interprocess_semaphore.html +++ b/doc/html/boost/interprocess/interprocess_semaphore.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_hpp" title="Header <boost/interprocess/sync/interprocess_semaphore.hpp>"> -<link rel="prev" href="interprocess_r_idp64020000.html" title="Class interprocess_recursive_mutex"> -<link rel="next" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex"> +<link rel="prev" href="interprocess_r_idp56904592.html" title="Class interprocess_recursive_mutex"> +<link rel="next" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_r_idp64020000.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_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="interprocess_s_idp64065392.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_r_idp56904592.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_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="interprocess_s_idp56949984.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.interprocess_semaphore"></a><div class="titlepage"></div> @@ -36,52 +36,52 @@ <span class="keyword">class</span> <a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="interprocess_semaphore.html#boost.interprocess.interprocess_semaphoreconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="interprocess_semaphore.html#idp64058320-bb"><span class="identifier">interprocess_semaphore</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_semaphore.html#idp64061232-bb"><span class="special">~</span><span class="identifier">interprocess_semaphore</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_semaphore.html#idp56942912-bb"><span class="identifier">interprocess_semaphore</span></a><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_semaphore.html#idp56945824-bb"><span class="special">~</span><span class="identifier">interprocess_semaphore</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="interprocess_semaphore.html#idp64041504-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idp64042064-bb"><span class="identifier">post</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idp64045712-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_semaphore.html#idp64049344-bb"><span class="identifier">try_wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_semaphore.html#idp64052976-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_semaphore.html#idp56926096-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idp56926656-bb"><span class="identifier">post</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_semaphore.html#idp56930304-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_semaphore.html#idp56933936-bb"><span class="identifier">try_wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_semaphore.html#idp56937568-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</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="idp265196016"></a><h2>Description</h2> +<a name="idp284049152"></a><h2>Description</h2> <p>Wraps a <a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </p> <div class="refsect2"> -<a name="idp265197760"></a><h3> +<a name="idp284050896"></a><h3> <a name="boost.interprocess.interprocess_semaphoreconstruct-copy-destruct"></a><code class="computeroutput">interprocess_semaphore</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64058320-bb"></a><span class="identifier">interprocess_semaphore</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span> initialCount<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56942912-bb"></a><span class="identifier">interprocess_semaphore</span><span class="special">(</span><span class="keyword">unsigned</span> <span class="keyword">int</span> initialCount<span class="special">)</span><span class="special">;</span></pre> <p>Creates a <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> with the given initial count. <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if there is an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64061232-bb"></a><span class="special">~</span><span class="identifier">interprocess_semaphore</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56945824-bb"></a><span class="special">~</span><span class="identifier">interprocess_semaphore</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>. Does not throw </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp265213616"></a><h3> -<a name="idp64041504-bb"></a><code class="computeroutput">interprocess_semaphore</code> public member functions</h3> +<a name="idp284066880"></a><h3> +<a name="idp56926096-bb"></a><code class="computeroutput">interprocess_semaphore</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64042064-bb"></a><span class="identifier">post</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56926656-bb"></a><span class="identifier">post</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Increments the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> count. If there are processes/threads blocked waiting for the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>, then one of these processes will return successfully from its wait function. If there is an error an <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> exception is thrown. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64045712-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56930304-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Decrements the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>. If the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> value is not greater than zero, then the calling process/thread blocks until it can decrement the counter. If there is an error an <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> exception is thrown. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64049344-bb"></a><span class="identifier">try_wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56933936-bb"></a><span class="identifier">try_wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Decrements the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> if the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>'s value is greater than zero and returns true. If the value is not greater than zero returns false. If there is an error an <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> exception is thrown. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64052976-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56937568-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Decrements the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> if the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code>'s value is greater than zero and returns true. Otherwise, waits for the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> to the posted or the timeout expires. If the timeout expires, the function returns false. If the <code class="computeroutput"><a class="link" href="interprocess_semaphore.html" title="Class interprocess_semaphore">interprocess_semaphore</a></code> is posted the function returns true. If there is an error throws sem_exception </p> </li> </ol></div> @@ -98,7 +98,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_r_idp64020000.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_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="interprocess_s_idp64065392.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_r_idp56904592.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_semaphore_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="interprocess_s_idp56949984.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/interprocess_u_idp64096208.html b/doc/html/boost/interprocess/interprocess_u_idp56980800.html index 208dae6e88..d0573801b5 100644 --- a/doc/html/boost/interprocess/interprocess_u_idp64096208.html +++ b/doc/html/boost/interprocess/interprocess_u_idp56980800.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_upgradable_mutex_hpp" title="Header <boost/interprocess/sync/interprocess_upgradable_mutex.hpp>"> -<link rel="prev" href="interprocess_s_idp64065392.html" title="Class interprocess_sharable_mutex"> +<link rel="prev" href="interprocess_s_idp56949984.html" title="Class interprocess_sharable_mutex"> <link rel="next" href="defer_lock_type.html" title="Struct defer_lock_type"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_s_idp64065392.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_upgradable_mutex_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="defer_lock_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_s_idp56949984.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_upgradable_mutex_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="defer_lock_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.interprocess_u_idp64096208"></a><div class="titlepage"></div> +<a name="boost.interprocess.interprocess_u_idp56980800"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Class interprocess_upgradable_mutex</span></h2> <p>boost::interprocess::interprocess_upgradable_mutex</p> @@ -33,141 +33,141 @@ <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.sync.interprocess_upgradable_mutex_hpp" title="Header <boost/interprocess/sync/interprocess_upgradable_mutex.hpp>">boost/interprocess/sync/interprocess_upgradable_mutex.hpp</a>> </span> -<span class="keyword">class</span> <a class="link" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">{</span> +<span class="keyword">class</span> <a class="link" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> - <span class="comment">// <a class="link" href="interprocess_u_idp64096208.html#boost.interprocess.interprocess_u_idp64096208construct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="interprocess_u_idp64096208.html#idp64098624-bb"><span class="identifier">interprocess_upgradable_mutex</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_u_idp64096208.html#idp64151296-bb"><span class="identifier">interprocess_upgradable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span> - <a class="link" href="interprocess_u_idp64096208.html#idp64100064-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="interprocess_u_idp64096208.html#idp64152768-bb"><span class="special">~</span><span class="identifier">interprocess_upgradable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_u_idp56980800.html#boost.interprocess.interprocess_u_idp56980800construct-copy-destruct">construct/copy/destruct</a></span> + <a class="link" href="interprocess_u_idp56980800.html#idp56983216-bb"><span class="identifier">interprocess_upgradable_mutex</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_u_idp56980800.html#idp57035888-bb"><span class="identifier">interprocess_upgradable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span> + <a class="link" href="interprocess_u_idp56980800.html#idp56984656-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="interprocess_u_idp56980800.html#idp57037360-bb"><span class="special">~</span><span class="identifier">interprocess_upgradable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="interprocess_u_idp64096208.html#idp64102096-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64102656-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64104864-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64107168-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64110160-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64112336-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64114528-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64116800-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64119776-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64121952-bb"><span class="identifier">lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64124160-bb"><span class="identifier">try_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64126464-bb"><span class="identifier">timed_lock_upgradable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64129456-bb"><span class="identifier">unlock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64131632-bb"><span class="identifier">unlock_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64133872-bb"><span class="identifier">unlock_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64136112-bb"><span class="identifier">unlock_upgradable_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="interprocess_u_idp64096208.html#idp64138352-bb"><span class="identifier">unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64140672-bb"><span class="identifier">try_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="special">*</span><span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64143088-bb"><span class="identifier">timed_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64146272-bb"><span class="identifier">try_unlock_sharable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp64096208.html#idp64148704-bb"><span class="identifier">try_unlock_sharable_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="interprocess_u_idp56980800.html#idp56986688-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp56987248-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp56989456-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp56991760-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp56994752-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp56996928-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp56999120-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp57001392-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp57004368-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp57006544-bb"><span class="identifier">lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp57008752-bb"><span class="identifier">try_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp57011056-bb"><span class="identifier">timed_lock_upgradable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp57014048-bb"><span class="identifier">unlock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp57016224-bb"><span class="identifier">unlock_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp57018464-bb"><span class="identifier">unlock_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp57020704-bb"><span class="identifier">unlock_upgradable_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="interprocess_u_idp56980800.html#idp57022944-bb"><span class="identifier">unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp57025264-bb"><span class="identifier">try_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="special">*</span><span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp57027680-bb"><span class="identifier">timed_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp57030864-bb"><span class="identifier">try_unlock_sharable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="interprocess_u_idp56980800.html#idp57033296-bb"><span class="identifier">try_unlock_sharable_and_lock_upgradable</span></a><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="idp265549520"></a><h2>Description</h2> -<p>Wraps a <a class="link" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </p> +<a name="idp284402752"></a><h2>Description</h2> +<p>Wraps a <a class="link" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> that can be placed in shared memory and can be shared between processes. Allows timed lock tries </p> <div class="refsect2"> -<a name="idp265551280"></a><h3> -<a name="boost.interprocess.interprocess_u_idp64096208construct-copy-destruct"></a><code class="computeroutput">interprocess_upgradable_mutex</code> +<a name="idp284404512"></a><h3> +<a name="boost.interprocess.interprocess_u_idp56980800construct-copy-destruct"></a><code class="computeroutput">interprocess_upgradable_mutex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> -<li class="listitem"><pre class="literallayout"><a name="idp64098624-bb"></a><span class="identifier">interprocess_upgradable_mutex</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp56983216-bb"></a><span class="identifier">interprocess_upgradable_mutex</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><a name="idp64151296-bb"></a><span class="identifier">interprocess_upgradable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57035888-bb"></a><span class="identifier">interprocess_upgradable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs the upgradable lock. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> -<li class="listitem"><pre class="literallayout"><a class="link" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span> -<a name="idp64100064-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_u_idp64096208.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a class="link" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span> +<a name="idp56984656-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="interprocess_u_idp56980800.html" title="Class interprocess_upgradable_mutex">interprocess_upgradable_mutex</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><a name="idp64152768-bb"></a><span class="special">~</span><span class="identifier">interprocess_upgradable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57037360-bb"></a><span class="special">~</span><span class="identifier">interprocess_upgradable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys the upgradable lock. Does not throw. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp265576768"></a><h3> -<a name="idp64102096-bb"></a><code class="computeroutput">interprocess_upgradable_mutex</code> public member functions</h3> +<a name="idp284430064"></a><h3> +<a name="idp56986688-bb"></a><code class="computeroutput">interprocess_upgradable_mutex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64102656-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56987248-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, sharable or upgradable ownership of the mutex, it waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64104864-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56989456-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive, sharable or upgradable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64107168-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56991760-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, sharable or upgradable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64110160-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56994752-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64112336-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56996928-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64114528-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56999120-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64116800-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57001392-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64119776-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57004368-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64121952-bb"></a><span class="identifier">lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57006544-bb"></a><span class="identifier">lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64124160-bb"></a><span class="identifier">try_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57008752-bb"></a><span class="identifier">try_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting. If no other thread has exclusive or upgradable ownership of the mutex this succeeds. Returns: If it can acquire upgradable ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64126464-bb"></a><span class="identifier">timed_lock_upgradable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57011056-bb"></a><span class="identifier">timed_lock_upgradable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64129456-bb"></a><span class="identifier">unlock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57014048-bb"></a><span class="identifier">unlock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The calling thread releases the upgradable ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64131632-bb"></a><span class="identifier">unlock_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57016224-bb"></a><span class="identifier">unlock_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The thread atomically releases exclusive ownership and acquires upgradable ownership. This operation is non-blocking. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64133872-bb"></a><span class="identifier">unlock_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57018464-bb"></a><span class="identifier">unlock_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The thread atomically releases exclusive ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64136112-bb"></a><span class="identifier">unlock_upgradable_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57020704-bb"></a><span class="identifier">unlock_upgradable_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64138352-bb"></a><span class="identifier">unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57022944-bb"></a><span class="identifier">unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and acquires exclusive ownership. This operation will block until all threads with sharable ownership release their sharable lock. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64140672-bb"></a><span class="identifier">try_unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57025264-bb"></a><span class="identifier">try_unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable ownership, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="special">*</span><span class="keyword">bool</span> <a name="idp64143088-bb"></a><span class="identifier">timed_unlock_upgradable_and_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="special">*</span><span class="keyword">bool</span> <a name="idp57027680-bb"></a><span class="identifier">timed_unlock_upgradable_and_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership, waiting if necessary until abs_time. This operation will fail if there are threads with sharable ownership or timeout reaches, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64146272-bb"></a><span class="identifier">try_unlock_sharable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57030864-bb"></a><span class="identifier">try_unlock_sharable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have sharable ownership of the mutex. Effects: The thread atomically releases sharable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64148704-bb"></a><span class="identifier">try_unlock_sharable_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57033296-bb"></a><span class="identifier">try_unlock_sharable_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have sharable ownership of the mutex. Effects: The thread atomically releases sharable ownership and tries to acquire upgradable ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> </ol></div> @@ -184,7 +184,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="interprocess_s_idp64065392.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_upgradable_mutex_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="defer_lock_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="interprocess_s_idp56949984.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.sync.interprocess_upgradable_mutex_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="defer_lock_type.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/intrusive_ptr.html b/doc/html/boost/interprocess/intrusive_ptr.html index 5ce980f2a3..17913d7ad9 100644 --- a/doc/html/boost/interprocess/intrusive_ptr.html +++ b/doc/html/boost/interprocess/intrusive_ptr.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> <link rel="prev" href="deleter.html" title="Class template deleter"> -<link rel="next" href="operator___idp63401200.html" title="Function template operator=="> +<link rel="next" href="operator___idp56285792.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="deleter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63401200.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="deleter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56285792.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.intrusive_ptr"></a><div class="titlepage"></div> @@ -40,107 +40,107 @@ <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.interprocess.intrusive_ptr.element_type"></a><span class="identifier">element_type</span><span class="special">;</span> <span class="comment">// Provides the type of the stored pointer. </span> <span class="comment">// <a class="link" href="intrusive_ptr.html#boost.interprocess.intrusive_ptrconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="intrusive_ptr.html#idp63385008-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="intrusive_ptr.html#idp63385760-bb"><span class="identifier">intrusive_ptr</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">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="intrusive_ptr.html#idp63388256-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</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> U<span class="special">></span> <a class="link" href="intrusive_ptr.html#idp63390048-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp63393504-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intrusive_ptr.html#idp56269600-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intrusive_ptr.html#idp56270352-bb"><span class="identifier">intrusive_ptr</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">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intrusive_ptr.html#idp56272848-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</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> U<span class="special">></span> <a class="link" href="intrusive_ptr.html#idp56274640-bb"><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp56278096-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</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> U<span class="special">></span> - <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp63395824-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp63398992-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="intrusive_ptr.html#idp63392704-bb"><span class="special">~</span><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp56280416-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp56283584-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intrusive_ptr.html#idp56277296-bb"><span class="special">~</span><span class="identifier">intrusive_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="intrusive_ptr.html#idp63371616-bb">public member functions</a></span> - <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp63372176-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp63373488-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp63375072-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp63376624-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp63378176-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="intrusive_ptr.html#idp63379456-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="intrusive_ptr.html#idp63381008-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="intrusive_ptr.html#idp63382560-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="intrusive_ptr.html#idp56256208-bb">public member functions</a></span> + <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp56256768-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp56258080-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">T</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp56259664-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp56261216-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="intrusive_ptr.html#idp56262768-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="intrusive_ptr.html#idp56264048-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="intrusive_ptr.html#idp56265600-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="intrusive_ptr.html#idp56267152-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <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="idp260979456"></a><h2>Description</h2> +<a name="idp279830240"></a><h2>Description</h2> <p>The <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> class template stores a pointer to an object with an embedded reference count. <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> is parameterized on T (the type of the object pointed to) and VoidPointer(a void pointer type that defines the type of pointer that <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> will store). intrusive_ptr<T, void *> defines a class with a T* member whereas <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><T, offset_ptr<void> > defines a class with a offset_ptr<T> member. Relies on unqualified calls to:</p> <p>void intrusive_ptr_add_ref(T * p); void intrusive_ptr_release(T * p);</p> <p>with (p != 0)</p> <p>The object is responsible for destroying itself. </p> <div class="refsect2"> -<a name="idp260985024"></a><h3> +<a name="idp279835808"></a><h3> <a name="boost.interprocess.intrusive_ptrconstruct-copy-destruct"></a><code class="computeroutput">intrusive_ptr</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63385008-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56269600-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Initializes internal pointer to 0. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63385760-bb"></a><span class="identifier">intrusive_ptr</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">bool</span> add_ref <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56270352-bb"></a><span class="identifier">intrusive_ptr</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">bool</span> add_ref <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Copies pointer and if "p" is not zero and "add_ref" is true calls intrusive_ptr_add_ref(to_raw_pointer(p)). Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63388256-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56272848-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor. Copies the internal pointer and if "p" is not zero calls intrusive_ptr_add_ref(to_raw_pointer(p)). Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> <a name="idp63390048-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> <a name="idp56274640-bb"></a><span class="identifier">intrusive_ptr</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Constructor from related. Copies the internal pointer and if "p" is not zero calls intrusive_ptr_add_ref(to_raw_pointer(p)). Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idp63393504-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idp56278096-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Assignment operator. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> U<span class="special">></span> - <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idp63395824-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> + <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idp56280416-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Assignment from related. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idp63398992-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">pointer</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> <a name="idp56283584-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">pointer</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Assignment from pointer. Equivalent to intrusive_ptr(r).swap(*this). Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63392704-bb"></a><span class="special">~</span><span class="identifier">intrusive_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56277296-bb"></a><span class="special">~</span><span class="identifier">intrusive_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destructor. If internal pointer is not 0, calls intrusive_ptr_release(to_raw_pointer(m_ptr)). Does not throw </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp261051184"></a><h3> -<a name="idp63371616-bb"></a><code class="computeroutput">intrusive_ptr</code> public member functions</h3> +<a name="idp279901984"></a><h3> +<a name="idp56256208-bb"></a><code class="computeroutput">intrusive_ptr</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp63372176-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56256768-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns a reference to the internal pointer. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp63373488-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56258080-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a reference to the internal pointer. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">T</span> <span class="special">&</span> <a name="idp63375072-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">T</span> <span class="special">&</span> <a name="idp56259664-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns *get(). Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp63376624-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56261216-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns *get(). Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp63378176-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56262768-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns get(). Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63379456-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56264048-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Conversion to boolean. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63381008-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56265600-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Not operator. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63382560-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56267152-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre> <p>Exchanges the contents of the two smart pointers. Does not throw </p> </li> </ol></div> @@ -157,7 +157,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="deleter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63401200.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="deleter.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56285792.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/iset_index.html b/doc/html/boost/interprocess/iset_index.html index 3a5a6b9708..f36e6c9856 100644 --- a/doc/html/boost/interprocess/iset_index.html +++ b/doc/html/boost/interprocess/iset_index.html @@ -42,43 +42,43 @@ <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">value_type</span> <a name="boost.interprocess.iset_index.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="iset_index.html#boost.interprocess.iset_indexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="iset_index.html#idp62407968-bb"><span class="identifier">iset_index</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="iset_index.html#idp55292560-bb"><span class="identifier">iset_index</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="iset_index.html#idp62398416-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="iset_index.html#idp62398976-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</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="iset_index.html#idp62401024-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">iterator</span> <a class="link" href="iset_index.html#idp62402176-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">const_iterator</span> <a class="link" href="iset_index.html#idp62403728-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="iset_index.html#idp55283008-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="iset_index.html#idp55283568-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</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="iset_index.html#idp55285616-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="iset_index.html#idp55286768-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="iset_index.html#idp55288320-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</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">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> - <a class="link" href="iset_index.html#idp62405552-bb"><span class="identifier">insert_check</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="iset_index.html#idp55290144-bb"><span class="identifier">insert_check</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">insert_commit_data</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="idp255219328"></a><h2>Description</h2> +<a name="idp274070064"></a><h2>Description</h2> <p>Index type based in boost::intrusive::set. Just derives from boost::intrusive::set and defines the interface needed by managed memory segments </p> <div class="refsect2"> -<a name="idp255220160"></a><h3> +<a name="idp274070896"></a><h3> <a name="boost.interprocess.iset_indexconstruct-copy-destruct"></a><code class="computeroutput">iset_index</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp62407968-bb"></a><span class="identifier">iset_index</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55292560-bb"></a><span class="identifier">iset_index</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Takes a pointer to the segment manager. Can throw </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp255229360"></a><h3> -<a name="idp62398416-bb"></a><code class="computeroutput">iset_index</code> public member functions</h3> +<a name="idp274080096"></a><h3> +<a name="idp55283008-bb"></a><code class="computeroutput">iset_index</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62398976-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55283568-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">MapConfig</span><span class="special">::</span><span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span></pre> <p>This reserves memory to optimize the insertion of n elements in the index </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62401024-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>This frees all unnecessary memory. </li> -<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp62402176-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp62403728-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55285616-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>This frees all unnecessary memory. </li> +<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp55286768-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp55288320-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></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">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> -<a name="idp62405552-bb"></a><span class="identifier">insert_check</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">,</span> +<a name="idp55290144-bb"></a><span class="identifier">insert_check</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&</span> commit_data<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> diff --git a/doc/html/boost/interprocess/iunordered_set_index.html b/doc/html/boost/interprocess/iunordered_set_index.html index b5c17f480b..42fcf2a7d9 100644 --- a/doc/html/boost/interprocess/iunordered_set_index.html +++ b/doc/html/boost/interprocess/iunordered_set_index.html @@ -48,52 +48,52 @@ <span class="keyword">typedef</span> <span class="identifier">index_type</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.iunordered_set_index.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="iunordered_set_index.html#boost.interprocess.iunordered_set_indexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="iunordered_set_index.html#idp62433904-bb"><span class="identifier">iunordered_set_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="iunordered_set_index.html#idp62435632-bb"><span class="special">~</span><span class="identifier">iunordered_set_index</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="iunordered_set_index.html#idp55318496-bb"><span class="identifier">iunordered_set_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="iunordered_set_index.html#idp55320224-bb"><span class="special">~</span><span class="identifier">iunordered_set_index</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="iunordered_set_index.html#idp62422016-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="iunordered_set_index.html#idp62422576-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="iunordered_set_index.html#idp62424592-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">iterator</span> <a class="link" href="iunordered_set_index.html#idp62425888-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">const_iterator</span> <a class="link" href="iunordered_set_index.html#idp62427440-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="iunordered_set_index.html#idp55306608-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="iunordered_set_index.html#idp55307168-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="iunordered_set_index.html#idp55309184-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="iunordered_set_index.html#idp55310480-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="iunordered_set_index.html#idp55312032-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</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">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> - <a class="link" href="iunordered_set_index.html#idp62429264-bb"><span class="identifier">insert_check</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">iterator</span> <a class="link" href="iunordered_set_index.html#idp62431520-bb"><span class="identifier">insert_commit</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="iunordered_set_index.html#idp55313856-bb"><span class="identifier">insert_check</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="iunordered_set_index.html#idp55316112-bb"><span class="identifier">insert_commit</span></a><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">insert_commit_data</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="idp255380112"></a><h2>Description</h2> +<a name="idp274230832"></a><h2>Description</h2> <p>Index type based in boost::intrusive::set. Just derives from boost::intrusive::set and defines the interface needed by managed memory segments </p> <div class="refsect2"> -<a name="idp255380944"></a><h3> +<a name="idp274231664"></a><h3> <a name="boost.interprocess.iunordered_set_indexconstruct-copy-destruct"></a><code class="computeroutput">iunordered_set_index</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62433904-bb"></a><span class="identifier">iunordered_set_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> mngr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55318496-bb"></a><span class="identifier">iunordered_set_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> mngr<span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Takes a pointer to the segment manager. Can throw </p> </li> -<li class="listitem"><pre class="literallayout"><a name="idp62435632-bb"></a><span class="special">~</span><span class="identifier">iunordered_set_index</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><a name="idp55320224-bb"></a><span class="special">~</span><span class="identifier">iunordered_set_index</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> <div class="refsect2"> -<a name="idp255392736"></a><h3> -<a name="idp62422016-bb"></a><code class="computeroutput">iunordered_set_index</code> public member functions</h3> +<a name="idp274243568"></a><h3> +<a name="idp55306608-bb"></a><code class="computeroutput">iunordered_set_index</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62422576-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="identifier">size_type</span> new_n<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55307168-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="identifier">size_type</span> new_n<span class="special">)</span><span class="special">;</span></pre> <p>This reserves memory to optimize the insertion of n elements in the index </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62424592-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55309184-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>This tries to free unused memory previously allocated. </p> </li> -<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp62425888-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp62427440-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp55310480-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp55312032-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></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">iterator</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">></span> -<a name="idp62429264-bb"></a><span class="identifier">insert_check</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">,</span> +<a name="idp55313856-bb"></a><span class="identifier">insert_check</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">intrusive_compare_key_type</span> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&</span> commit_data<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp62431520-bb"></a><span class="identifier">insert_commit</span><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&</span> val<span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&</span> commit_data<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">iterator</span> <a name="idp55316112-bb"></a><span class="identifier">insert_commit</span><span class="special">(</span><span class="identifier">value_type</span> <span class="special">&</span> val<span class="special">,</span> <span class="identifier">insert_commit_data</span> <span class="special">&</span> commit_data<span class="special">)</span><span class="special">;</span></pre></li> </ol></div> </div> </div> diff --git a/doc/html/boost/interprocess/lock_exception.html b/doc/html/boost/interprocess/lock_exception.html index 2565a59746..5982906ee4 100644 --- a/doc/html/boost/interprocess/lock_exception.html +++ b/doc/html/boost/interprocess/lock_exception.html @@ -36,25 +36,25 @@ <span class="keyword">class</span> <a class="link" href="lock_exception.html" title="Class lock_exception">lock_exception</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">interprocess</span><span class="special">::</span><span class="identifier">interprocess_exception</span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="lock_exception.html#boost.interprocess.lock_exceptionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="lock_exception.html#idp62351360-bb"><span class="identifier">lock_exception</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="lock_exception.html#idp55235952-bb"><span class="identifier">lock_exception</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="lock_exception.html#idp62349248-bb">public member functions</a></span> - <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="lock_exception.html#idp62349808-bb"><span class="identifier">what</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="lock_exception.html#idp55233840-bb">public member functions</a></span> + <span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="lock_exception.html#idp55234400-bb"><span class="identifier">what</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254862000"></a><h2>Description</h2> +<a name="idp273712592"></a><h2>Description</h2> <p>This is the exception thrown by shared <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> family when a deadlock situation is detected or when using a <a class="link" href="interprocess_condition.html" title="Class interprocess_condition">interprocess_condition</a> the <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> is not locked </p> <div class="refsect2"> -<a name="idp254865504"></a><h3> +<a name="idp273716016"></a><h3> <a name="boost.interprocess.lock_exceptionconstruct-copy-destruct"></a><code class="computeroutput">lock_exception</code> public construct/copy/destruct</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp62351360-bb"></a><span class="identifier">lock_exception</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><a name="idp55235952-bb"></a><span class="identifier">lock_exception</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre></li></ol></div> </div> <div class="refsect2"> -<a name="idp254871360"></a><h3> -<a name="idp62349248-bb"></a><code class="computeroutput">lock_exception</code> public member functions</h3> -<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp62349808-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> +<a name="idp273721872"></a><h3> +<a name="idp55233840-bb"></a><code class="computeroutput">lock_exception</code> public member functions</h3> +<div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"><pre class="literallayout"><span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp55234400-bb"></a><span class="identifier">what</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre></li></ol></div> </div> </div> </div> diff --git a/doc/html/boost/interprocess/make_managed_s_idp63632112.html b/doc/html/boost/interprocess/make_managed_s_idp56516704.html index 5da24c1553..0812b83509 100644 --- a/doc/html/boost/interprocess/make_managed_s_idp63632112.html +++ b/doc/html/boost/interprocess/make_managed_s_idp56516704.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_hpp" title="Header <boost/interprocess/smart_ptr/shared_ptr.hpp>"> <link rel="prev" href="managed_shared_ptr.html" title="Struct template managed_shared_ptr"> -<link rel="next" href="make_managed_s_idp63636624.html" title="Function template make_managed_shared_ptr"> +<link rel="next" href="make_managed_s_idp56521216.html" title="Function template make_managed_shared_ptr"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="managed_shared_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="make_managed_s_idp63636624.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="managed_shared_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="make_managed_s_idp56521216.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.make_managed_s_idp63632112"></a><div class="titlepage"></div> +<a name="boost.interprocess.make_managed_s_idp56516704"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template make_managed_shared_ptr</span></h2> <p>boost::interprocess::make_managed_shared_ptr</p> @@ -38,7 +38,7 @@ <span class="identifier">make_managed_shared_ptr</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> constructed_object<span class="special">,</span> <span class="identifier">ManagedMemory</span> <span class="special">&</span> managed_memory<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp262444928"></a><h2>Description</h2> +<a name="idp281296176"></a><h2>Description</h2> <p>Returns an instance of a shared pointer constructed with the default allocator and deleter from a pointer of type T that has been allocated in the passed managed segment </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="managed_shared_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="make_managed_s_idp63636624.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="managed_shared_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="make_managed_s_idp56521216.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/make_managed_s_idp63636624.html b/doc/html/boost/interprocess/make_managed_s_idp56521216.html index 5ab303373f..4462ade458 100644 --- a/doc/html/boost/interprocess/make_managed_s_idp63636624.html +++ b/doc/html/boost/interprocess/make_managed_s_idp56521216.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_hpp" title="Header <boost/interprocess/smart_ptr/shared_ptr.hpp>"> -<link rel="prev" href="make_managed_s_idp63632112.html" title="Function template make_managed_shared_ptr"> +<link rel="prev" href="make_managed_s_idp56516704.html" title="Function template make_managed_shared_ptr"> <link rel="next" href="managed_unique_ptr.html" title="Struct template managed_unique_ptr"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="make_managed_s_idp63632112.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="managed_unique_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="make_managed_s_idp56516704.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="managed_unique_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.make_managed_s_idp63636624"></a><div class="titlepage"></div> +<a name="boost.interprocess.make_managed_s_idp56521216"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template make_managed_shared_ptr</span></h2> <p>boost::interprocess::make_managed_shared_ptr</p> @@ -39,7 +39,7 @@ <span class="identifier">ManagedMemory</span> <span class="special">&</span> managed_memory<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp262467968"></a><h2>Description</h2> +<a name="idp281319152"></a><h2>Description</h2> <p>Returns an instance of a shared pointer constructed with the default allocator and deleter from a pointer of type T that has been allocated in the passed managed segment. Does not throw, return null shared pointer in error. </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="make_managed_s_idp63632112.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="managed_unique_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="make_managed_s_idp56516704.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="managed_unique_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/make_managed_unique_ptr.html b/doc/html/boost/interprocess/make_managed_unique_ptr.html index 3773603add..c3e436f665 100644 --- a/doc/html/boost/interprocess/make_managed_unique_ptr.html +++ b/doc/html/boost/interprocess/make_managed_unique_ptr.html @@ -38,7 +38,7 @@ <span class="identifier">make_managed_unique_ptr</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> constructed_object<span class="special">,</span> <span class="identifier">ManagedMemory</span> <span class="special">&</span> managed_memory<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp262543696"></a><h2>Description</h2> +<a name="idp281394752"></a><h2>Description</h2> <p>Returns an instance of a unique pointer constructed with boost::interproces::deleter from a pointer of type T that has been allocated in the passed managed segment </p> </div> </div> diff --git a/doc/html/boost/interprocess/make_managed_weak_ptr.html b/doc/html/boost/interprocess/make_managed_weak_ptr.html index c13066a981..b85d137c7e 100644 --- a/doc/html/boost/interprocess/make_managed_weak_ptr.html +++ b/doc/html/boost/interprocess/make_managed_weak_ptr.html @@ -38,7 +38,7 @@ <span class="identifier">make_managed_weak_ptr</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> constructed_object<span class="special">,</span> <span class="identifier">ManagedMemory</span> <span class="special">&</span> managed_memory<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp262903616"></a><h2>Description</h2> +<a name="idp281754672"></a><h2>Description</h2> <p>Returns an instance of a weak pointer constructed with the default allocator and deleter from a pointer of type T that has been allocated in the passed managed segment </p> </div> </div> diff --git a/doc/html/boost/interprocess/managed_external_buffer.html b/doc/html/boost/interprocess/managed_external_buffer.html index d3de447089..5dd9aec9fc 100644 --- a/doc/html/boost/interprocess/managed_external_buffer.html +++ b/doc/html/boost/interprocess/managed_external_buffer.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_external_buffer_hpp" title="Header <boost/interprocess/managed_external_buffer.hpp>"> -<link rel="prev" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer"> +<link rel="prev" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer"> <link rel="next" href="wmanaged_external_buffer.html" title="Type definition wmanaged_external_buffer"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_managed__idp62606272.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_external_buffer_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="wmanaged_external_buffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_managed__idp55490864.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_external_buffer_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="wmanaged_external_buffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.managed_external_buffer"></a><div class="titlepage"></div> @@ -33,10 +33,10 @@ <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.managed_external_buffer_hpp" title="Header <boost/interprocess/managed_external_buffer.hpp>">boost/interprocess/managed_external_buffer.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="null_mutex_family.html" title="Struct null_mutex_family">null_mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_external_buffer</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="null_mutex_family.html" title="Struct null_mutex_family">null_mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_external_buffer</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp256254240"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> of narrow characters </p> +<a name="idp275104848"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> of narrow characters </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_managed__idp62606272.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_external_buffer_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="wmanaged_external_buffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_managed__idp55490864.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_external_buffer_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="wmanaged_external_buffer.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/managed_heap_memory.html b/doc/html/boost/interprocess/managed_heap_memory.html index 0b4d0d3952..58b2eea2c5 100644 --- a/doc/html/boost/interprocess/managed_heap_memory.html +++ b/doc/html/boost/interprocess/managed_heap_memory.html @@ -35,7 +35,7 @@ </span> <span class="keyword">typedef</span> <a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="null_mutex_family.html" title="Struct null_mutex_family">null_mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_heap_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp256420768"></a><h2>Description</h2> +<a name="idp275271136"></a><h2>Description</h2> <p>Typedef for a default <a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> of narrow characters </p> </div> </div> diff --git a/doc/html/boost/interprocess/managed_mapped_file.html b/doc/html/boost/interprocess/managed_mapped_file.html index 0fe86b825e..ad94ca909e 100644 --- a/doc/html/boost/interprocess/managed_mapped_file.html +++ b/doc/html/boost/interprocess/managed_mapped_file.html @@ -35,7 +35,7 @@ </span> <span class="keyword">typedef</span> <a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_mapped_file</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp256751504"></a><h2>Description</h2> +<a name="idp275601712"></a><h2>Description</h2> <p>Typedef for a default <a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> of narrow characters </p> </div> </div> diff --git a/doc/html/boost/interprocess/managed_shared_memory.html b/doc/html/boost/interprocess/managed_shared_memory.html index 2e571ea359..16b22728db 100644 --- a/doc/html/boost/interprocess/managed_shared_memory.html +++ b/doc/html/boost/interprocess/managed_shared_memory.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_hpp" title="Header <boost/interprocess/managed_shared_memory.hpp>"> -<link rel="prev" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory"> +<link rel="prev" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory"> <link rel="next" href="wmanaged_shared_memory.html" title="Type definition wmanaged_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_managed__idp62714784.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="wmanaged_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_managed__idp55599376.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="wmanaged_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.managed_shared_memory"></a><div class="titlepage"></div> @@ -33,10 +33,10 @@ <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.managed_shared_memory_hpp" title="Header <boost/interprocess/managed_shared_memory.hpp>">boost/interprocess/managed_shared_memory.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_shared_memory</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_shared_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257086096"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> of narrow characters </p> +<a name="idp275936224"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> of narrow characters </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_managed__idp62714784.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="wmanaged_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_managed__idp55599376.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="wmanaged_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/managed_shared_ptr.html b/doc/html/boost/interprocess/managed_shared_ptr.html index 74b15ae922..cdcbfe9319 100644 --- a/doc/html/boost/interprocess/managed_shared_ptr.html +++ b/doc/html/boost/interprocess/managed_shared_ptr.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_hpp" title="Header <boost/interprocess/smart_ptr/shared_ptr.hpp>"> <link rel="prev" href="shared_ptr.html" title="Class template shared_ptr"> -<link rel="next" href="make_managed_s_idp63632112.html" title="Function template make_managed_shared_ptr"> +<link rel="next" href="make_managed_s_idp56516704.html" title="Function template make_managed_shared_ptr"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="shared_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="make_managed_s_idp63632112.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="shared_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="make_managed_s_idp56516704.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.managed_shared_ptr"></a><div class="titlepage"></div> @@ -40,7 +40,7 @@ <span class="keyword">typedef</span> <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">void_allocator</span><span class="special">,</span> <span class="identifier">deleter</span> <span class="special">></span> <a name="boost.interprocess.managed_shared_ptr.type"></a><span class="identifier">type</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp262423920"></a><h2>Description</h2> +<a name="idp281275104"></a><h2>Description</h2> <p>Returns the type of a shared pointer of type T with the allocator <a class="link" href="allocator.html" title="Class template allocator">boost::interprocess::allocator</a> allocator and <a class="link" href="deleter.html" title="Class template deleter">boost::interprocess::deleter</a> deleter that can be constructed in the given managed segment type. </p> </div> </div> @@ -54,7 +54,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="shared_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="make_managed_s_idp63632112.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="shared_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.shared_ptr_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="make_managed_s_idp56516704.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/managed_unique_ptr.html b/doc/html/boost/interprocess/managed_unique_ptr.html index 67f203c268..e285c1d787 100644 --- a/doc/html/boost/interprocess/managed_unique_ptr.html +++ b/doc/html/boost/interprocess/managed_unique_ptr.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.unique_ptr_hpp" title="Header <boost/interprocess/smart_ptr/unique_ptr.hpp>"> -<link rel="prev" href="make_managed_s_idp63636624.html" title="Function template make_managed_shared_ptr"> +<link rel="prev" href="make_managed_s_idp56521216.html" title="Function template make_managed_shared_ptr"> <link rel="next" href="make_managed_unique_ptr.html" title="Function template make_managed_unique_ptr"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="make_managed_s_idp63636624.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.unique_ptr_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="make_managed_unique_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="make_managed_s_idp56521216.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.unique_ptr_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="make_managed_unique_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.managed_unique_ptr"></a><div class="titlepage"></div> @@ -38,7 +38,7 @@ <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">movelib</span><span class="special">::</span><span class="identifier">unique_ptr</span><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">ManagedMemory</span><span class="special">::</span><span class="keyword">template</span> <a class="link" href="deleter.html" title="Class template deleter">deleter</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <span class="special">></span> <a name="boost.interprocess.managed_unique_ptr.type"></a><span class="identifier">type</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp262523520"></a><h2>Description</h2> +<a name="idp281374640"></a><h2>Description</h2> <p>Returns the type of a unique pointer of type T with <a class="link" href="deleter.html" title="Class template deleter">boost::interprocess::deleter</a> deleter that can be constructed in the given managed segment type. </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="make_managed_s_idp63636624.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.unique_ptr_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="make_managed_unique_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="make_managed_s_idp56521216.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.unique_ptr_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="make_managed_unique_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/managed_weak_ptr.html b/doc/html/boost/interprocess/managed_weak_ptr.html index ff648f4819..398dedf1e3 100644 --- a/doc/html/boost/interprocess/managed_weak_ptr.html +++ b/doc/html/boost/interprocess/managed_weak_ptr.html @@ -38,7 +38,7 @@ <span class="keyword">typedef</span> <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">ManagedMemory</span><span class="special">::</span><span class="keyword">template</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="keyword">void</span> <span class="special">></span><span class="special">::</span><a class="link" href="managed_weak_ptr.html#boost.interprocess.managed_weak_ptr.type">type</a><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">ManagedMemory</span><span class="special">::</span><span class="keyword">template</span> <a class="link" href="deleter.html" title="Class template deleter">deleter</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><a class="link" href="managed_weak_ptr.html#boost.interprocess.managed_weak_ptr.type">type</a> <span class="special">></span> <a name="boost.interprocess.managed_weak_ptr.type"></a><span class="identifier">type</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp262882560"></a><h2>Description</h2> +<a name="idp281733616"></a><h2>Description</h2> <p>Returns the type of a weak pointer of type T with the allocator <a class="link" href="allocator.html" title="Class template allocator">boost::interprocess::allocator</a> allocator and <a class="link" href="deleter.html" title="Class template deleter">boost::interprocess::deleter</a> deleter that can be constructed in the given managed segment type. </p> </div> </div> diff --git a/doc/html/boost/interprocess/managed_window_idp62811600.html b/doc/html/boost/interprocess/managed_window_idp55696192.html index c95f4025ff..38f202862d 100644 --- a/doc/html/boost/interprocess/managed_window_idp62811600.html +++ b/doc/html/boost/interprocess/managed_window_idp55696192.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_hpp" title="Header <boost/interprocess/managed_windows_shared_memory.hpp>"> -<link rel="prev" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory"> -<link rel="next" href="wmanaged_windo_idp62815312.html" title="Type definition wmanaged_windows_shared_memory"> +<link rel="prev" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory"> +<link rel="next" href="wmanaged_windo_idp55699904.html" title="Type definition wmanaged_windows_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_managed__idp62772528.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="wmanaged_windo_idp62815312.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_managed__idp55657120.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="wmanaged_windo_idp55699904.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.managed_window_idp62811600"></a><div class="titlepage"></div> +<a name="boost.interprocess.managed_window_idp55696192"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Type definition managed_windows_shared_memory</span></h2> <p>managed_windows_shared_memory</p> @@ -33,10 +33,10 @@ <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.managed_windows_shared_memory_hpp" title="Header <boost/interprocess/managed_windows_shared_memory.hpp>">boost/interprocess/managed_windows_shared_memory.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_windows_shared_memory</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_windows_shared_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257406880"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> of narrow characters </p> +<a name="idp276257152"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> of narrow characters </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_managed__idp62772528.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="wmanaged_windo_idp62815312.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_managed__idp55657120.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="wmanaged_windo_idp55699904.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/managed_xsi_shared_memory.html b/doc/html/boost/interprocess/managed_xsi_shared_memory.html index 262634d6f4..e999aac8ac 100644 --- a/doc/html/boost/interprocess/managed_xsi_shared_memory.html +++ b/doc/html/boost/interprocess/managed_xsi_shared_memory.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_hpp" title="Header <boost/interprocess/managed_xsi_shared_memory.hpp>"> -<link rel="prev" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory"> +<link rel="prev" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory"> <link rel="next" href="wmanaged_xsi_shared_memory.html" title="Type definition wmanaged_xsi_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_managed__idp62821248.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_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="wmanaged_xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_managed__idp55705840.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_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="wmanaged_xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.managed_xsi_shared_memory"></a><div class="titlepage"></div> @@ -33,10 +33,10 @@ <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.managed_xsi_shared_memory_hpp" title="Header <boost/interprocess/managed_xsi_shared_memory.hpp>">boost/interprocess/managed_xsi_shared_memory.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_xsi_shared_memory</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a><span class="special"><</span> <span class="keyword">char</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">managed_xsi_shared_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257697088"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> of narrow characters </p> +<a name="idp276547104"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> of narrow characters </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="basic_managed__idp62821248.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_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="wmanaged_xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="basic_managed__idp55705840.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_xsi_shared_memory_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="wmanaged_xsi_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/map_index.html b/doc/html/boost/interprocess/map_index.html index 7098f74429..04fee4b1a6 100644 --- a/doc/html/boost/interprocess/map_index.html +++ b/doc/html/boost/interprocess/map_index.html @@ -36,35 +36,35 @@ <span class="keyword">class</span> <a class="link" href="map_index.html" title="Class template map_index">map_index</a> <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">container</span><span class="special">::</span><span class="identifier">map</span><span class="special"><</span> <span class="identifier">MapConfig</span> <span class="special">></span> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="map_index.html#boost.interprocess.map_indexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="map_index.html#idp62445088-bb"><span class="identifier">map_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="map_index.html#idp55329680-bb"><span class="identifier">map_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="map_index.html#idp62441024-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="map_index.html#idp62441584-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</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="map_index.html#idp62443632-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="map_index.html#idp55325616-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="map_index.html#idp55326176-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</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="map_index.html#idp55328224-bb"><span class="identifier">shrink_to_fit</span></a><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="idp255485360"></a><h2>Description</h2> +<a name="idp274336064"></a><h2>Description</h2> <p>Index type based in boost::interprocess::map. Just derives from boost::interprocess::map and defines the interface needed by managed memory segments </p> <div class="refsect2"> -<a name="idp255486192"></a><h3> +<a name="idp274336896"></a><h3> <a name="boost.interprocess.map_indexconstruct-copy-destruct"></a><code class="computeroutput">map_index</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp62445088-bb"></a><span class="identifier">map_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55329680-bb"></a><span class="identifier">map_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Takes a pointer to the segment manager. Can throw </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp255493968"></a><h3> -<a name="idp62441024-bb"></a><code class="computeroutput">map_index</code> public member functions</h3> +<a name="idp274344672"></a><h3> +<a name="idp55325616-bb"></a><code class="computeroutput">map_index</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62441584-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55326176-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span></pre> <p>This reserves memory to optimize the insertion of n elements in the index </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62443632-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55328224-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>This tries to free previously allocate unused memory. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/mapped_region.html b/doc/html/boost/interprocess/mapped_region.html index 822a17ffc9..f562a63ecd 100644 --- a/doc/html/boost/interprocess/mapped_region.html +++ b/doc/html/boost/interprocess/mapped_region.html @@ -38,39 +38,39 @@ <span class="keyword">enum</span> <a class="link" href="mapped_region/advice_types.html" title="Type advice_types">advice_types</a><span class="special">;</span> <span class="comment">// <a class="link" href="mapped_region.html#boost.interprocess.mapped_regionconstruct-copy-destruct">construct/copy/destruct</a></span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MemoryMappable<span class="special">></span> - <a class="link" href="mapped_region.html#idp62896000-bb"><span class="identifier">mapped_region</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MemoryMappable</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">,</span> <span class="identifier">offset_t</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> + <a class="link" href="mapped_region.html#idp55780592-bb"><span class="identifier">mapped_region</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MemoryMappable</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">,</span> <span class="identifier">offset_t</span> <span class="special">=</span> <span class="number">0</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="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">map_options_t</span> <span class="special">=</span> <span class="identifier">default_map_options</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="mapped_region.html#idp62905776-bb"><span class="identifier">mapped_region</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="mapped_region.html#idp62906544-bb"><span class="identifier">mapped_region</span></a><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&</span> <a class="link" href="mapped_region.html#idp62909088-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="mapped_region.html#idp62908352-bb"><span class="special">~</span><span class="identifier">mapped_region</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="mapped_region.html#idp55790368-bb"><span class="identifier">mapped_region</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="mapped_region.html#idp55791136-bb"><span class="identifier">mapped_region</span></a><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&</span> <a class="link" href="mapped_region.html#idp55793680-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="mapped_region.html#idp55792944-bb"><span class="special">~</span><span class="identifier">mapped_region</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="mapped_region.html#idp62877392-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="mapped_region.html#idp62877952-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&</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="mapped_region.html#idp62880944-bb"><span class="identifier">get_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="mapped_region.html#idp62882384-bb"><span class="identifier">get_address</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mode_t</span> <a class="link" href="mapped_region.html#idp62883952-bb"><span class="identifier">get_mode</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="mapped_region.html#idp62885552-bb"><span class="identifier">flush</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="number">0</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="number">0</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="mapped_region.html#idp62890096-bb"><span class="identifier">shrink_by</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="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="mapped_region.html#idp62893472-bb"><span class="identifier">advise</span></a><span class="special">(</span><span class="identifier">advice_types</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="mapped_region.html#idp55761984-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="mapped_region.html#idp55762544-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&</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="mapped_region.html#idp55765536-bb"><span class="identifier">get_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="mapped_region.html#idp55766976-bb"><span class="identifier">get_address</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mode_t</span> <a class="link" href="mapped_region.html#idp55768544-bb"><span class="identifier">get_mode</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="mapped_region.html#idp55770144-bb"><span class="identifier">flush</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="number">0</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="number">0</span><span class="special">,</span> <span class="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="mapped_region.html#idp55774688-bb"><span class="identifier">shrink_by</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="keyword">bool</span> <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="mapped_region.html#idp55778064-bb"><span class="identifier">advise</span></a><span class="special">(</span><span class="identifier">advice_types</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="mapped_region.html#idp62911472-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="mapped_region.html#idp62912032-bb"><span class="identifier">get_page_size</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="mapped_region.html#idp55796064-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a class="link" href="mapped_region.html#idp55796624-bb"><span class="identifier">get_page_size</span></a><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="idp257826656"></a><h2>Description</h2> +<a name="idp276676416"></a><h2>Description</h2> <p>The <a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> class represents a portion or region created from a memory_mappable object.</p> <p>The OS can map a region bigger than the requested one, as region must be multiple of the page size, but <a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> will always refer to the region specified by the user. </p> <div class="refsect2"> -<a name="idp257829632"></a><h3> +<a name="idp276679392"></a><h3> <a name="boost.interprocess.mapped_regionconstruct-copy-destruct"></a><code class="computeroutput">mapped_region</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> MemoryMappable<span class="special">></span> - <a name="idp62896000-bb"></a><span class="identifier">mapped_region</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MemoryMappable</span> <span class="special">&</span> mapping<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> + <a name="idp55780592-bb"></a><span class="identifier">mapped_region</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">MemoryMappable</span> <span class="special">&</span> mapping<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> <span class="identifier">offset_t</span> offset <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> address <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">map_options_t</span> map_options <span class="special">=</span> <span class="identifier">default_map_options</span><span class="special">)</span><span class="special">;</span></pre> @@ -83,61 +83,61 @@ <p>The OS could allocate more pages than size/page_size(), but get_address() will always return the address passed in this function (if not null) and get_size() will return the specified size. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62905776-bb"></a><span class="identifier">mapped_region</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55790368-bb"></a><span class="identifier">mapped_region</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructor. Address will be 0 (nullptr). Size will be 0. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62906544-bb"></a><span class="identifier">mapped_region</span><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55791136-bb"></a><span class="identifier">mapped_region</span><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Move constructor. *this will be constructed taking ownership of "other"'s region and "other" will be left in default constructor state. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&</span> <a name="idp62909088-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&</span> <a name="idp55793680-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Move assignment. If *this owns a memory mapped region, it will be destroyed and it will take ownership of "other"'s memory mapped region. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62908352-bb"></a><span class="special">~</span><span class="identifier">mapped_region</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55792944-bb"></a><span class="special">~</span><span class="identifier">mapped_region</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys the mapped region. Does not throw </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp257878928"></a><h3> -<a name="idp62877392-bb"></a><code class="computeroutput">mapped_region</code> public member functions</h3> +<a name="idp276728752"></a><h3> +<a name="idp55761984-bb"></a><code class="computeroutput">mapped_region</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62877952-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55762544-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Swaps the <code class="computeroutput"><a class="link" href="mapped_region.html" title="Class mapped_region">mapped_region</a></code> with another mapped region </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="idp62880944-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the mapping. Never throws. </li> +<pre class="literallayout"><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp55765536-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the mapping. Never throws. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp62882384-bb"></a><span class="identifier">get_address</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp55766976-bb"></a><span class="identifier">get_address</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the base address of the mapping. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mode_t</span> <a name="idp62883952-bb"></a><span class="identifier">get_mode</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mode_t</span> <a name="idp55768544-bb"></a><span class="identifier">get_mode</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the mode of the mapping used to construct the mapped region. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62885552-bb"></a><span class="identifier">flush</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> mapping_offset <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> numbytes <span class="special">=</span> <span class="number">0</span><span class="special">,</span> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55770144-bb"></a><span class="identifier">flush</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> mapping_offset <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> numbytes <span class="special">=</span> <span class="number">0</span><span class="special">,</span> <span class="keyword">bool</span> async <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre> <p>Flushes to the disk a byte range within the mapped memory. If 'async' is true, the function will return before flushing operation is completed If 'async' is false, function will return once data has been written into the underlying device (i.e., in mapped files OS cached information is written to disk). Never throws. Returns false if operation could not be performed. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62890096-bb"></a><span class="identifier">shrink_by</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="keyword">bool</span> from_back <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55774688-bb"></a><span class="identifier">shrink_by</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> bytes<span class="special">,</span> <span class="keyword">bool</span> from_back <span class="special">=</span> <span class="keyword">true</span><span class="special">)</span><span class="special">;</span></pre> <p>Shrinks current mapped region. If after shrinking there is no longer need for a previously mapped memory page, accessing that page can trigger a segmentation fault. Depending on the OS, this operation might fail (XSI shared memory), it can decommit storage and free a portion of the virtual address space (e.g.POSIX) or this function can release some physical memory wihout freeing any virtual address space(Windows). Returns true on success. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62893472-bb"></a><span class="identifier">advise</span><span class="special">(</span><span class="identifier">advice_types</span> advise<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55778064-bb"></a><span class="identifier">advise</span><span class="special">(</span><span class="identifier">advice_types</span> advise<span class="special">)</span><span class="special">;</span></pre> <p>Advises the implementation on the expected behavior of the application with respect to the data in the region. The implementation may use this information to optimize handling of the region data. This function has no effect on the semantics of access to memory in the region, although it may affect the performance of access. If the advise type is not known to the implementation, the function returns false. True otherwise. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp257935248"></a><h3> -<a name="idp62911472-bb"></a><code class="computeroutput">mapped_region</code> public static functions</h3> +<a name="idp276784944"></a><h3> +<a name="idp55796064-bb"></a><code class="computeroutput">mapped_region</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp62912032-bb"></a><span class="identifier">get_page_size</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <a name="idp55796624-bb"></a><span class="identifier">get_page_size</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the size of the page. This size is the minimum memory that will be used by the system when mapping a memory mappable source and will restrict the address and the offset to map. </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/mapped_region/advice_types.html b/doc/html/boost/interprocess/mapped_region/advice_types.html index 1ca278e4fc..21a390cc03 100644 --- a/doc/html/boost/interprocess/mapped_region/advice_types.html +++ b/doc/html/boost/interprocess/mapped_region/advice_types.html @@ -6,7 +6,7 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../mapped_region.html#idp257826656" title="Description"> +<link rel="up" href="../mapped_region.html#idp276676416" title="Description"> <link rel="prev" href="../mapped_region.html" title="Class mapped_region"> <link rel="next" href="../rbtree_best_fit.html" title="Class template rbtree_best_fit"> </head> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../mapped_region.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mapped_region.html#idp257826656"><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="../rbtree_best_fit.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../mapped_region.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mapped_region.html#idp276676416"><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="../rbtree_best_fit.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.mapped_region.advice_types"></a><div class="titlepage"></div> @@ -36,7 +36,7 @@ <span class="keyword">enum</span> <span class="identifier">advice_types</span> <span class="special">{</span> <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_normal">advice_normal</a>, <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_sequential">advice_sequential</a>, <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_random">advice_random</a>, <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_willneed">advice_willneed</a>, <a class="link" href="advice_types.html#boost.interprocess.mapped_region.advice_types.advice_dontneed">advice_dontneed</a> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257956224"></a><h2>Description</h2> +<a name="idp276806080"></a><h2>Description</h2> <p>This enum specifies region usage behaviors that an application can specify to the mapped region implementation. </p> <div class="variablelist"><dl class="variablelist compact"> <dt><span class="term"><code class="computeroutput">advice_normal</code><a name="boost.interprocess.mapped_region.advice_types.advice_normal"></a></span></dt> @@ -62,7 +62,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../mapped_region.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mapped_region.html#idp257826656"><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="../rbtree_best_fit.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../mapped_region.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../mapped_region.html#idp276676416"><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="../rbtree_best_fit.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/message_queue.html b/doc/html/boost/interprocess/message_queue.html index b95338c664..b9df0b6742 100644 --- a/doc/html/boost/interprocess/message_queue.html +++ b/doc/html/boost/interprocess/message_queue.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.ipc.message_queue_hpp" title="Header <boost/interprocess/ipc/message_queue.hpp>"> <link rel="prev" href="message_queue_t.html" title="Class template message_queue_t"> -<link rel="next" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer"> +<link rel="next" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="message_queue_t.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.ipc.message_queue_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="basic_managed__idp62606272.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="message_queue_t.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.ipc.message_queue_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="basic_managed__idp55490864.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.message_queue"></a><div class="titlepage"></div> @@ -35,7 +35,7 @@ </span> <span class="keyword">typedef</span> <a class="link" href="message_queue_t.html" title="Class template message_queue_t">message_queue_t</a><span class="special"><</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="keyword">void</span> <span class="special">></span> <span class="special">></span> <span class="identifier">message_queue</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp256091088"></a><h2>Description</h2> +<a name="idp274941600"></a><h2>Description</h2> <p>Typedef for a default message queue to be used between processes </p> </div> </div> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="message_queue_t.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.ipc.message_queue_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="basic_managed__idp62606272.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="message_queue_t.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.ipc.message_queue_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="basic_managed__idp55490864.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/message_queue_t.html b/doc/html/boost/interprocess/message_queue_t.html index 7665d938f0..0b2428b136 100644 --- a/doc/html/boost/interprocess/message_queue_t.html +++ b/doc/html/boost/interprocess/message_queue_t.html @@ -42,114 +42,114 @@ <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.interprocess.message_queue_t.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="message_queue_t.html#boost.interprocess.message_queue_tconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="message_queue_t.html#idp62583504-bb"><span class="identifier">message_queue_t</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</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> + <a class="link" href="message_queue_t.html#idp55468096-bb"><span class="identifier">message_queue_t</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</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="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="message_queue_t.html#idp62589312-bb"><span class="identifier">message_queue_t</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</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> + <a class="link" href="message_queue_t.html#idp55473904-bb"><span class="identifier">message_queue_t</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</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="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="message_queue_t.html#idp62595216-bb"><span class="identifier">message_queue_t</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="message_queue_t.html#idp62597568-bb"><span class="special">~</span><span class="identifier">message_queue_t</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="message_queue_t.html#idp55479808-bb"><span class="identifier">message_queue_t</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="message_queue_t.html#idp55482160-bb"><span class="special">~</span><span class="identifier">message_queue_t</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="message_queue_t.html#idp62552736-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="message_queue_t.html#idp62553296-bb"><span class="identifier">send</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp62556816-bb"><span class="identifier">try_send</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp62560384-bb"><span class="identifier">timed_send</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> + <span class="comment">// <a class="link" href="message_queue_t.html#idp55437328-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="message_queue_t.html#idp55437888-bb"><span class="identifier">send</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp55441408-bb"><span class="identifier">try_send</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp55444976-bb"><span class="identifier">timed_send</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="message_queue_t.html#idp62564720-bb"><span class="identifier">receive</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</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">unsigned</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp62568992-bb"><span class="identifier">try_receive</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</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">unsigned</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp62573312-bb"><span class="identifier">timed_receive</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</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">unsigned</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">,</span> + <span class="keyword">void</span> <a class="link" href="message_queue_t.html#idp55449312-bb"><span class="identifier">receive</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</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">unsigned</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp55453584-bb"><span class="identifier">try_receive</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</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">unsigned</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp55457904-bb"><span class="identifier">timed_receive</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</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">unsigned</span> <span class="keyword">int</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="message_queue_t.html#idp62578416-bb"><span class="identifier">get_max_msg</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="message_queue_t.html#idp62580096-bb"><span class="identifier">get_max_msg_size</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="message_queue_t.html#idp62581760-bb"><span class="identifier">get_num_msg</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="message_queue_t.html#idp55463008-bb"><span class="identifier">get_max_msg</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="message_queue_t.html#idp55464688-bb"><span class="identifier">get_max_msg_size</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="message_queue_t.html#idp55466352-bb"><span class="identifier">get_num_msg</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="message_queue_t.html#idp62598672-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp62599232-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="message_queue_t.html#idp55483264-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="message_queue_t.html#idp55483824-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp255927792"></a><h2>Description</h2> +<a name="idp274778032"></a><h2>Description</h2> <p>A class that allows sending messages between processes. </p> <div class="refsect2"> -<a name="idp255928464"></a><h3> +<a name="idp274778784"></a><h3> <a name="boost.interprocess.message_queue_tconstruct-copy-destruct"></a><code class="computeroutput">message_queue_t</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62583504-bb"></a><span class="identifier">message_queue_t</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55468096-bb"></a><span class="identifier">message_queue_t</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> max_num_msg<span class="special">,</span> <span class="identifier">size_type</span> max_msg_size<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a process shared message queue with name "name". For this message queue, the maximum number of messages will be "max_num_msg" and the maximum message size will be "max_msg_size". Throws on error and if the queue was previously created. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62589312-bb"></a><span class="identifier">message_queue_t</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp55473904-bb"></a><span class="identifier">message_queue_t</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">size_type</span> max_num_msg<span class="special">,</span> <span class="identifier">size_type</span> max_msg_size<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Opens or creates a process shared message queue with name "name". If the queue is created, the maximum number of messages will be "max_num_msg" and the maximum message size will be "max_msg_size". If queue was previously created the queue will be opened and "max_num_msg" and "max_msg_size" parameters are ignored. Throws on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62595216-bb"></a><span class="identifier">message_queue_t</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55479808-bb"></a><span class="identifier">message_queue_t</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Opens a previously created process shared message queue with name "name". If the queue was not previously created or there are no free resources, throws an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62597568-bb"></a><span class="special">~</span><span class="identifier">message_queue_t</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55482160-bb"></a><span class="special">~</span><span class="identifier">message_queue_t</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. All opened message queues are still valid after destruction. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the message queue from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp255974768"></a><h3> -<a name="idp62552736-bb"></a><code class="computeroutput">message_queue_t</code> public member functions</h3> +<a name="idp274825168"></a><h3> +<a name="idp55437328-bb"></a><code class="computeroutput">message_queue_t</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62553296-bb"></a><span class="identifier">send</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> priority<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55437888-bb"></a><span class="identifier">send</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> priority<span class="special">)</span><span class="special">;</span></pre> <p>Sends a message stored in buffer "buffer" with size "buffer_size" in the message queue with priority "priority". If the message queue is full the sender is blocked. Throws interprocess_error on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62556816-bb"></a><span class="identifier">try_send</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55441408-bb"></a><span class="identifier">try_send</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> priority<span class="special">)</span><span class="special">;</span></pre> <p>Sends a message stored in buffer "buffer" with size "buffer_size" through the message queue with priority "priority". If the message queue is full the sender is not blocked and returns false, otherwise returns true. Throws interprocess_error on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62560384-bb"></a><span class="identifier">timed_send</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55444976-bb"></a><span class="identifier">timed_send</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> priority<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Sends a message stored in buffer "buffer" with size "buffer_size" in the message queue with priority "priority". If the message queue is full the sender retries until time "abs_time" is reached. Returns true if the message has been successfully sent. Returns false if timeout is reached. Throws interprocess_error on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62564720-bb"></a><span class="identifier">receive</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span> recvd_size<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55449312-bb"></a><span class="identifier">receive</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span> recvd_size<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="special">&</span> priority<span class="special">)</span><span class="special">;</span></pre> <p>Receives a message from the message queue. The message is stored in buffer "buffer", which has size "buffer_size". The received message has size "recvd_size" and priority "priority". If the message queue is empty the receiver is blocked. Throws interprocess_error on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62568992-bb"></a><span class="identifier">try_receive</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span> recvd_size<span class="special">,</span> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55453584-bb"></a><span class="identifier">try_receive</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span> recvd_size<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="special">&</span> priority<span class="special">)</span><span class="special">;</span></pre> <p>Receives a message from the message queue. The message is stored in buffer "buffer", which has size "buffer_size". The received message has size "recvd_size" and priority "priority". If the message queue is empty the receiver is not blocked and returns false, otherwise returns true. Throws interprocess_error on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62573312-bb"></a><span class="identifier">timed_receive</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55457904-bb"></a><span class="identifier">timed_receive</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> buffer<span class="special">,</span> <span class="identifier">size_type</span> buffer_size<span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span> recvd_size<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> <span class="special">&</span> priority<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Receives a message from the message queue. The message is stored in buffer "buffer", which has size "buffer_size". The received message has size "recvd_size" and priority "priority". If the message queue is empty the receiver retries until time "abs_time" is reached. Returns true if the message has been successfully sent. Returns false if timeout is reached. Throws interprocess_error on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62578416-bb"></a><span class="identifier">get_max_msg</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55463008-bb"></a><span class="identifier">get_max_msg</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the maximum number of messages allowed by the queue. The message queue must be opened or created previously. Otherwise, returns 0. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62580096-bb"></a><span class="identifier">get_max_msg_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55464688-bb"></a><span class="identifier">get_max_msg_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the maximum size of message allowed by the queue. The message queue must be opened or created previously. Otherwise, returns 0. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62581760-bb"></a><span class="identifier">get_num_msg</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55466352-bb"></a><span class="identifier">get_num_msg</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the number of messages currently stored. Never throws </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp256070848"></a><h3> -<a name="idp62598672-bb"></a><code class="computeroutput">message_queue_t</code> public static functions</h3> +<a name="idp274921344"></a><h3> +<a name="idp55483264-bb"></a><code class="computeroutput">message_queue_t</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp62599232-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp55483824-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Removes the message queue from the system. Returns false on error. Never throws </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/mutex_family.html b/doc/html/boost/interprocess/mutex_family.html index c1a4aeca8e..5ad8d809b2 100644 --- a/doc/html/boost/interprocess/mutex_family.html +++ b/doc/html/boost/interprocess/mutex_family.html @@ -36,10 +36,10 @@ <span class="keyword">struct</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">{</span> <span class="comment">// types</span> <span class="keyword">typedef</span> <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">boost::interprocess::interprocess_mutex</a> <a name="boost.interprocess.mutex_family.mutex_type"></a><span class="identifier">mutex_type</span><span class="special">;</span> - <span class="keyword">typedef</span> <a class="link" href="interprocess_r_idp64020000.html" title="Class interprocess_recursive_mutex">boost::interprocess::interprocess_recursive_mutex</a> <a name="boost.interprocess.mutex_family.recursive_mutex_type"></a><span class="identifier">recursive_mutex_type</span><span class="special">;</span> + <span class="keyword">typedef</span> <a class="link" href="interprocess_r_idp56904592.html" title="Class interprocess_recursive_mutex">boost::interprocess::interprocess_recursive_mutex</a> <a name="boost.interprocess.mutex_family.recursive_mutex_type"></a><span class="identifier">recursive_mutex_type</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp265816160"></a><h2>Description</h2> +<a name="idp284669184"></a><h2>Description</h2> <p>Describes <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> family to use with Interprocess framework based on boost::interprocess synchronization objects. </p> </div> </div> diff --git a/doc/html/boost/interprocess/named_condition.html b/doc/html/boost/interprocess/named_condition.html index ed0c217620..61c0b10f0e 100644 --- a/doc/html/boost/interprocess/named_condition.html +++ b/doc/html/boost/interprocess/named_condition.html @@ -36,92 +36,92 @@ <span class="keyword">class</span> <a class="link" href="named_condition.html" title="Class named_condition">named_condition</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="named_condition.html#boost.interprocess.named_conditionconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="named_condition.html#idp64198976-bb"><span class="identifier">named_condition</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_condition.html#idp57083568-bb"><span class="identifier">named_condition</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_condition.html#idp64204000-bb"><span class="identifier">named_condition</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_condition.html#idp57088592-bb"><span class="identifier">named_condition</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_condition.html#idp64211296-bb"><span class="identifier">named_condition</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_condition.html#idp64214368-bb"><span class="special">~</span><span class="identifier">named_condition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_condition.html#idp57095888-bb"><span class="identifier">named_condition</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_condition.html#idp57098960-bb"><span class="special">~</span><span class="identifier">named_condition</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_condition.html#idp64178400-bb">public member functions</a></span> - <span class="special">*</span><span class="keyword">void</span> <a class="link" href="named_condition.html#idp64178960-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_condition.html#idp64180320-bb"><span class="identifier">notify_all</span></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> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="named_condition.html#idp64181696-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a class="link" href="named_condition.html#idp64185408-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="named_condition.html#idp64189488-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_condition.html#idp57062992-bb">public member functions</a></span> + <span class="special">*</span><span class="keyword">void</span> <a class="link" href="named_condition.html#idp57063552-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_condition.html#idp57064912-bb"><span class="identifier">notify_all</span></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> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="named_condition.html#idp57066288-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a class="link" href="named_condition.html#idp57070000-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="named_condition.html#idp57074080-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> - <span class="keyword">bool</span> <a class="link" href="named_condition.html#idp64193984-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_condition.html#idp57078576-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_condition.html#idp64215408-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_condition.html#idp64215968-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_condition.html#idp57100000-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_condition.html#idp57100560-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp265947520"></a><h2>Description</h2> +<a name="idp284800480"></a><h2>Description</h2> <p>A global condition variable that can be created by name. This condition variable is designed to work with <a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a> and can't be placed in shared memory or memory mapped files. </p> <div class="refsect2"> -<a name="idp265949280"></a><h3> +<a name="idp284802240"></a><h3> <a name="boost.interprocess.named_conditionconstruct-copy-destruct"></a><code class="computeroutput">named_condition</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64198976-bb"></a><span class="identifier">named_condition</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57083568-bb"></a><span class="identifier">named_condition</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a global condition with a name. If the condition can't be created throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64204000-bb"></a><span class="identifier">named_condition</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57088592-bb"></a><span class="identifier">named_condition</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Opens or creates a global condition with a name. If the condition is created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_condition.html" title="Class named_condition">named_condition</a></code>(<code class="computeroutput"><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a></code>, ... ) If the condition is already created, this call is equivalent <code class="computeroutput"><a class="link" href="named_condition.html" title="Class named_condition">named_condition</a></code>(<code class="computeroutput"><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a></code>, ... ) Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64211296-bb"></a><span class="identifier">named_condition</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57095888-bb"></a><span class="identifier">named_condition</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Opens a global condition with a name if that condition is previously created. If it is not previously created this function throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64214368-bb"></a><span class="special">~</span><span class="identifier">named_condition</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57098960-bb"></a><span class="special">~</span><span class="identifier">named_condition</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp265997200"></a><h3> -<a name="idp64178400-bb"></a><code class="computeroutput">named_condition</code> public member functions</h3> +<a name="idp284850032"></a><h3> +<a name="idp57062992-bb"></a><code class="computeroutput">named_condition</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="special">*</span><span class="keyword">void</span> <a name="idp64178960-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="special">*</span><span class="keyword">void</span> <a name="idp57063552-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64180320-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57064912-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="idp64181696-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="idp57066288-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">)</span><span class="special">;</span></pre> <p>Releases the lock on the <code class="computeroutput"><a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), and then reacquires the lock. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a name="idp64185408-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a name="idp57070000-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> <p>The same as: while (!pred()) wait(lock) </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> - <span class="keyword">bool</span> <a name="idp64189488-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> + <span class="keyword">bool</span> <a name="idp57074080-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Releases the lock on the <code class="computeroutput"><a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), or until time abs_time is reached, and then reacquires the lock. Returns: false if time abs_time is reached, otherwise true. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> - <span class="keyword">bool</span> <a name="idp64193984-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">,</span> + <span class="keyword">bool</span> <a name="idp57078576-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> <p>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266061856"></a><h3> -<a name="idp64215408-bb"></a><code class="computeroutput">named_condition</code> public static functions</h3> +<a name="idp284914640"></a><h3> +<a name="idp57100000-bb"></a><code class="computeroutput">named_condition</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp64215968-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp57100560-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Erases a named condition from the system. Returns false on error. Never throws. </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/named_condition_any.html b/doc/html/boost/interprocess/named_condition_any.html index 91487a9658..8a608d1467 100644 --- a/doc/html/boost/interprocess/named_condition_any.html +++ b/doc/html/boost/interprocess/named_condition_any.html @@ -36,92 +36,92 @@ <span class="keyword">class</span> <a class="link" href="named_condition_any.html" title="Class named_condition_any">named_condition_any</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="named_condition_any.html#boost.interprocess.named_condition_anyconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="named_condition_any.html#idp64243408-bb"><span class="identifier">named_condition_any</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_condition_any.html#idp57128000-bb"><span class="identifier">named_condition_any</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_condition_any.html#idp64248432-bb"><span class="identifier">named_condition_any</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_condition_any.html#idp57133024-bb"><span class="identifier">named_condition_any</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_condition_any.html#idp64255760-bb"><span class="identifier">named_condition_any</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_condition_any.html#idp64258832-bb"><span class="special">~</span><span class="identifier">named_condition_any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_condition_any.html#idp57140352-bb"><span class="identifier">named_condition_any</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_condition_any.html#idp57143424-bb"><span class="special">~</span><span class="identifier">named_condition_any</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_condition_any.html#idp64222832-bb">public member functions</a></span> - <span class="special">*</span><span class="keyword">void</span> <a class="link" href="named_condition_any.html#idp64223392-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_condition_any.html#idp64224752-bb"><span class="identifier">notify_all</span></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> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="named_condition_any.html#idp64226128-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a class="link" href="named_condition_any.html#idp64229840-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="named_condition_any.html#idp64233920-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_condition_any.html#idp57107424-bb">public member functions</a></span> + <span class="special">*</span><span class="keyword">void</span> <a class="link" href="named_condition_any.html#idp57107984-bb"><span class="identifier">notify_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_condition_any.html#idp57109344-bb"><span class="identifier">notify_all</span></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> L<span class="special">></span> <span class="keyword">void</span> <a class="link" href="named_condition_any.html#idp57110720-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a class="link" href="named_condition_any.html#idp57114432-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="named_condition_any.html#idp57118512-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</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> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> - <span class="keyword">bool</span> <a class="link" href="named_condition_any.html#idp64238416-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_condition_any.html#idp57123008-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">Pr</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_condition_any.html#idp64259872-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_condition_any.html#idp64260432-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_condition_any.html#idp57144464-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_condition_any.html#idp57145024-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp266184640"></a><h2>Description</h2> +<a name="idp285037616"></a><h2>Description</h2> <p>A global condition variable that can be created by name. This condition variable is designed to work with <a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a> and can't be placed in shared memory or memory mapped files. </p> <div class="refsect2"> -<a name="idp266186320"></a><h3> +<a name="idp285039376"></a><h3> <a name="boost.interprocess.named_condition_anyconstruct-copy-destruct"></a><code class="computeroutput">named_condition_any</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64243408-bb"></a><span class="identifier">named_condition_any</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57128000-bb"></a><span class="identifier">named_condition_any</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a global condition with a name. If the condition can't be created throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64248432-bb"></a><span class="identifier">named_condition_any</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57133024-bb"></a><span class="identifier">named_condition_any</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Opens or creates a global condition with a name. If the condition is created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_condition_any.html" title="Class named_condition_any">named_condition_any</a></code>(<code class="computeroutput"><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a></code>, ... ) If the condition is already created, this call is equivalent <code class="computeroutput"><a class="link" href="named_condition_any.html" title="Class named_condition_any">named_condition_any</a></code>(<code class="computeroutput"><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a></code>, ... ) Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64255760-bb"></a><span class="identifier">named_condition_any</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57140352-bb"></a><span class="identifier">named_condition_any</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Opens a global condition with a name if that condition is previously created. If it is not previously created this function throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64258832-bb"></a><span class="special">~</span><span class="identifier">named_condition_any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57143424-bb"></a><span class="special">~</span><span class="identifier">named_condition_any</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266233728"></a><h3> -<a name="idp64222832-bb"></a><code class="computeroutput">named_condition_any</code> public member functions</h3> +<a name="idp285086688"></a><h3> +<a name="idp57107424-bb"></a><code class="computeroutput">named_condition_any</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="special">*</span><span class="keyword">void</span> <a name="idp64223392-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="special">*</span><span class="keyword">void</span> <a name="idp57107984-bb"></a><span class="identifier">notify_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>If there is a thread waiting on *this, change that thread's state to ready. Otherwise there is no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64224752-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57109344-bb"></a><span class="identifier">notify_all</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Change the state of all threads waiting on *this to ready. If there are no waiting threads, notify_all() has no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="idp64226128-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> <span class="keyword">void</span> <a name="idp57110720-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">)</span><span class="special">;</span></pre> <p>Releases the lock on the <code class="computeroutput"><a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), and then reacquires the lock. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a name="idp64229840-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> <span class="keyword">void</span> <a name="idp57114432-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> <p>The same as: while (!pred()) wait(lock) </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">></span> - <span class="keyword">bool</span> <a name="idp64233920-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> + <span class="keyword">bool</span> <a name="idp57118512-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Releases the lock on the <code class="computeroutput"><a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a></code> object associated with lock, blocks the current thread of execution until readied by a call to this->notify_one() or this->notify_all(), or until time abs_time is reached, and then reacquires the lock. Returns: false if time abs_time is reached, otherwise true. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> L<span class="special">,</span> <span class="keyword">typename</span> Pr<span class="special">></span> - <span class="keyword">bool</span> <a name="idp64238416-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">,</span> + <span class="keyword">bool</span> <a name="idp57123008-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="identifier">L</span> <span class="special">&</span> lock<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">,</span> <span class="identifier">Pr</span> pred<span class="special">)</span><span class="special">;</span></pre> <p>The same as: while (!pred()) { if (!timed_wait(lock, abs_time)) return pred(); } return true; </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266298512"></a><h3> -<a name="idp64259872-bb"></a><code class="computeroutput">named_condition_any</code> public static functions</h3> +<a name="idp285151280"></a><h3> +<a name="idp57144464-bb"></a><code class="computeroutput">named_condition_any</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp64260432-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp57145024-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Erases a named condition from the system. Returns false on error. Never throws. </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/named_mutex.html b/doc/html/boost/interprocess/named_mutex.html index a9f922dbb6..de4e0133da 100644 --- a/doc/html/boost/interprocess/named_mutex.html +++ b/doc/html/boost/interprocess/named_mutex.html @@ -36,78 +36,78 @@ <span class="keyword">class</span> <a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="named_mutex.html#boost.interprocess.named_mutexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="named_mutex.html#idp64276320-bb"><span class="identifier">named_mutex</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_mutex.html#idp57160912-bb"><span class="identifier">named_mutex</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_mutex.html#idp64281312-bb"><span class="identifier">named_mutex</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_mutex.html#idp57165904-bb"><span class="identifier">named_mutex</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_mutex.html#idp64288592-bb"><span class="identifier">named_mutex</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_mutex.html#idp64291664-bb"><span class="special">~</span><span class="identifier">named_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_mutex.html#idp57173184-bb"><span class="identifier">named_mutex</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_mutex.html#idp57176256-bb"><span class="special">~</span><span class="identifier">named_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_mutex.html#idp64267280-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="named_mutex.html#idp64267840-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_mutex.html#idp64269120-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_mutex.html#idp64271200-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_mutex.html#idp64273328-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_mutex.html#idp57151872-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="named_mutex.html#idp57152432-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_mutex.html#idp57153712-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_mutex.html#idp57155792-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_mutex.html#idp57157920-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_mutex.html#idp64292704-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_mutex.html#idp64293264-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_mutex.html#idp57177296-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_mutex.html#idp57177856-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp266388128"></a><h2>Description</h2> +<a name="idp285241056"></a><h2>Description</h2> <p>A mutex with a global name, so it can be found from different processes. This mutex can't be placed in shared memory, and each process should have it's own <a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a>. </p> <div class="refsect2"> -<a name="idp266389856"></a><h3> +<a name="idp285242784"></a><h3> <a name="boost.interprocess.named_mutexconstruct-copy-destruct"></a><code class="computeroutput">named_mutex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64276320-bb"></a><span class="identifier">named_mutex</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57160912-bb"></a><span class="identifier">named_mutex</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a global mutex with a name. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64281312-bb"></a><span class="identifier">named_mutex</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57165904-bb"></a><span class="identifier">named_mutex</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Opens or creates a global mutex with a name. If the mutex is created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a></code>(<code class="computeroutput"><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a></code>, ... ) If the mutex is already created, this call is equivalent <code class="computeroutput"><a class="link" href="named_mutex.html" title="Class named_mutex">named_mutex</a></code>(<code class="computeroutput"><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a></code>, ... ) Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64288592-bb"></a><span class="identifier">named_mutex</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57173184-bb"></a><span class="identifier">named_mutex</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Opens a global mutex with a name if that mutex is previously created. If it is not previously created this function throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64291664-bb"></a><span class="special">~</span><span class="identifier">named_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57176256-bb"></a><span class="special">~</span><span class="identifier">named_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266437600"></a><h3> -<a name="idp64267280-bb"></a><code class="computeroutput">named_mutex</code> public member functions</h3> +<a name="idp285290656"></a><h3> +<a name="idp57151872-bb"></a><code class="computeroutput">named_mutex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64267840-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57152432-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Unlocks a previously locked mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64269120-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57153712-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Locks the mutex, sleeps when the mutex is already locked. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if a severe error is found </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64271200-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57155792-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Tries to lock the mutex, returns false when the mutex is already locked, returns true when success. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if a severe error is found </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64273328-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57157920-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Tries to lock the the mutex until time abs_time, Returns false when timeout expires, returns true when locks. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if a severe error is found </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266466592"></a><h3> -<a name="idp64292704-bb"></a><code class="computeroutput">named_mutex</code> public static functions</h3> +<a name="idp285319712"></a><h3> +<a name="idp57177296-bb"></a><code class="computeroutput">named_mutex</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp64293264-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp57177856-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Erases a named mutex from the system. Returns false on error. Never throws. </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/named_recursive_mutex.html b/doc/html/boost/interprocess/named_recursive_mutex.html index 5334cc3a1c..b849f3d0f4 100644 --- a/doc/html/boost/interprocess/named_recursive_mutex.html +++ b/doc/html/boost/interprocess/named_recursive_mutex.html @@ -36,78 +36,78 @@ <span class="keyword">class</span> <a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="named_recursive_mutex.html#boost.interprocess.named_recursive_mutexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="named_recursive_mutex.html#idp64313600-bb"><span class="identifier">named_recursive_mutex</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_recursive_mutex.html#idp57198192-bb"><span class="identifier">named_recursive_mutex</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_recursive_mutex.html#idp64318640-bb"><span class="identifier">named_recursive_mutex</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_recursive_mutex.html#idp57203232-bb"><span class="identifier">named_recursive_mutex</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_recursive_mutex.html#idp64325984-bb"><span class="identifier">named_recursive_mutex</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_recursive_mutex.html#idp64329072-bb"><span class="special">~</span><span class="identifier">named_recursive_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_recursive_mutex.html#idp57210576-bb"><span class="identifier">named_recursive_mutex</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_recursive_mutex.html#idp57213664-bb"><span class="special">~</span><span class="identifier">named_recursive_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_recursive_mutex.html#idp64300160-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="named_recursive_mutex.html#idp64300720-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_recursive_mutex.html#idp64302752-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_recursive_mutex.html#idp64306304-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_recursive_mutex.html#idp64309872-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_recursive_mutex.html#idp57184752-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="named_recursive_mutex.html#idp57185312-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_recursive_mutex.html#idp57187344-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_recursive_mutex.html#idp57190896-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_recursive_mutex.html#idp57194464-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_recursive_mutex.html#idp64330112-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_recursive_mutex.html#idp64330672-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_recursive_mutex.html#idp57214704-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_recursive_mutex.html#idp57215264-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp266556816"></a><h2>Description</h2> +<a name="idp285409808"></a><h2>Description</h2> <p>A recursive mutex with a global name, so it can be found from different processes. This mutex can't be placed in shared memory, and each process should have it's own <a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a>. </p> <div class="refsect2"> -<a name="idp266558592"></a><h3> +<a name="idp285411584"></a><h3> <a name="boost.interprocess.named_recursive_mutexconstruct-copy-destruct"></a><code class="computeroutput">named_recursive_mutex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64313600-bb"></a><span class="identifier">named_recursive_mutex</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57198192-bb"></a><span class="identifier">named_recursive_mutex</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a global recursive_mutex with a name. If the recursive_mutex can't be created throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64318640-bb"></a><span class="identifier">named_recursive_mutex</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57203232-bb"></a><span class="identifier">named_recursive_mutex</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Opens or creates a global recursive_mutex with a name. If the recursive_mutex is created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a></code>(<code class="computeroutput"><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a></code>, ... ) If the recursive_mutex is already created, this call is equivalent <code class="computeroutput"><a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a></code>(<code class="computeroutput"><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a></code>, ... ) Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64325984-bb"></a><span class="identifier">named_recursive_mutex</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57210576-bb"></a><span class="identifier">named_recursive_mutex</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Opens a global recursive_mutex with a name if that recursive_mutex is previously created. If it is not previously created this function throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64329072-bb"></a><span class="special">~</span><span class="identifier">named_recursive_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57213664-bb"></a><span class="special">~</span><span class="identifier">named_recursive_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266606480"></a><h3> -<a name="idp64300160-bb"></a><code class="computeroutput">named_recursive_mutex</code> public member functions</h3> +<a name="idp285459424"></a><h3> +<a name="idp57184752-bb"></a><code class="computeroutput">named_recursive_mutex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64300720-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57185312-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Unlocks a previously locked <code class="computeroutput"><a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64302752-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57187344-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Locks <code class="computeroutput"><a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a></code>, sleeps when <code class="computeroutput"><a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a></code> is already locked. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if a severe error is found. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64306304-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57190896-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Tries to lock the <code class="computeroutput"><a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a></code>, returns false when <code class="computeroutput"><a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a></code> is already locked, returns true when success. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if a severe error is found. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64309872-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57194464-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Tries to lock the <code class="computeroutput"><a class="link" href="named_recursive_mutex.html" title="Class named_recursive_mutex">named_recursive_mutex</a></code> until time abs_time, Returns false when timeout expires, returns true when locks. Throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> if a severe error is found </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266643040"></a><h3> -<a name="idp64330112-bb"></a><code class="computeroutput">named_recursive_mutex</code> public static functions</h3> +<a name="idp285496048"></a><h3> +<a name="idp57214704-bb"></a><code class="computeroutput">named_recursive_mutex</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp64330672-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp57215264-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Erases a named recursive mutex from the system </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/named_semaphore.html b/doc/html/boost/interprocess/named_semaphore.html index a3c5195a83..89f4c974cd 100644 --- a/doc/html/boost/interprocess/named_semaphore.html +++ b/doc/html/boost/interprocess/named_semaphore.html @@ -36,79 +36,79 @@ <span class="keyword">class</span> <a class="link" href="named_semaphore.html" title="Class named_semaphore">named_semaphore</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="named_semaphore.html#boost.interprocess.named_semaphoreconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="named_semaphore.html#idp64346272-bb"><span class="identifier">named_semaphore</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> + <a class="link" href="named_semaphore.html#idp57230864-bb"><span class="identifier">named_semaphore</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_semaphore.html#idp64352000-bb"><span class="identifier">named_semaphore</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> + <a class="link" href="named_semaphore.html#idp57236592-bb"><span class="identifier">named_semaphore</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_semaphore.html#idp64360016-bb"><span class="identifier">named_semaphore</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_semaphore.html#idp64363088-bb"><span class="special">~</span><span class="identifier">named_semaphore</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_semaphore.html#idp57244608-bb"><span class="identifier">named_semaphore</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_semaphore.html#idp57247680-bb"><span class="special">~</span><span class="identifier">named_semaphore</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_semaphore.html#idp64336768-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="named_semaphore.html#idp64337328-bb"><span class="identifier">post</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_semaphore.html#idp64339520-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_semaphore.html#idp64341696-bb"><span class="identifier">try_wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_semaphore.html#idp64343856-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_semaphore.html#idp57221360-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="named_semaphore.html#idp57221920-bb"><span class="identifier">post</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_semaphore.html#idp57224112-bb"><span class="identifier">wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_semaphore.html#idp57226288-bb"><span class="identifier">try_wait</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_semaphore.html#idp57228448-bb"><span class="identifier">timed_wait</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_semaphore.html#idp64364128-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_semaphore.html#idp64364688-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_semaphore.html#idp57248720-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_semaphore.html#idp57249280-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp266736800"></a><h2>Description</h2> +<a name="idp285589776"></a><h2>Description</h2> <p>A semaphore with a global name, so it can be found from different processes. Allows several resource sharing patterns and efficient acknowledgment mechanisms. </p> <div class="refsect2"> -<a name="idp266737648"></a><h3> +<a name="idp285590624"></a><h3> <a name="boost.interprocess.named_semaphoreconstruct-copy-destruct"></a><code class="computeroutput">named_semaphore</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64346272-bb"></a><span class="identifier">named_semaphore</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> initialCount<span class="special">,</span> +<pre class="literallayout"><a name="idp57230864-bb"></a><span class="identifier">named_semaphore</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> initialCount<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a global semaphore with a name, and an initial count. If the semaphore can't be created throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64352000-bb"></a><span class="identifier">named_semaphore</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57236592-bb"></a><span class="identifier">named_semaphore</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">int</span> initialCount<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Opens or creates a global semaphore with a name, and an initial count. If the semaphore is created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_semaphore.html" title="Class named_semaphore">named_semaphore</a></code>(<code class="computeroutput"><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a></code>, ...) If the semaphore is already created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_semaphore.html" title="Class named_semaphore">named_semaphore</a></code>(<code class="computeroutput"><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a></code>, ... ) and initialCount is ignored. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64360016-bb"></a><span class="identifier">named_semaphore</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57244608-bb"></a><span class="identifier">named_semaphore</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Opens a global semaphore with a name if that semaphore is previously. created. If it is not previously created this function throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64363088-bb"></a><span class="special">~</span><span class="identifier">named_semaphore</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57247680-bb"></a><span class="special">~</span><span class="identifier">named_semaphore</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266789200"></a><h3> -<a name="idp64336768-bb"></a><code class="computeroutput">named_semaphore</code> public member functions</h3> +<a name="idp285642160"></a><h3> +<a name="idp57221360-bb"></a><code class="computeroutput">named_semaphore</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64337328-bb"></a><span class="identifier">post</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57221920-bb"></a><span class="identifier">post</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Increments the semaphore count. If there are processes/threads blocked waiting for the semaphore, then one of these processes will return successfully from its wait function. If there is an error an <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> exception is thrown. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64339520-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57224112-bb"></a><span class="identifier">wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Decrements the semaphore. If the semaphore value is not greater than zero, then the calling process/thread blocks until it can decrement the counter. If there is an error an <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> exception is thrown. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64341696-bb"></a><span class="identifier">try_wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57226288-bb"></a><span class="identifier">try_wait</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Decrements the semaphore if the semaphore's value is greater than zero and returns true. If the value is not greater than zero returns false. If there is an error an <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> exception is thrown. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64343856-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57228448-bb"></a><span class="identifier">timed_wait</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Decrements the semaphore if the semaphore's value is greater than zero and returns true. Otherwise, waits for the semaphore to the posted or the timeout expires. If the timeout expires, the function returns false. If the semaphore is posted the function returns true. If there is an error throws sem_exception </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266818592"></a><h3> -<a name="idp64364128-bb"></a><code class="computeroutput">named_semaphore</code> public static functions</h3> +<a name="idp285671616"></a><h3> +<a name="idp57248720-bb"></a><code class="computeroutput">named_semaphore</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp64364688-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp57249280-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Erases a named semaphore from the system. Returns false on error. Never throws. </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/named_sharable_mutex.html b/doc/html/boost/interprocess/named_sharable_mutex.html index 2462d97911..759d0d5921 100644 --- a/doc/html/boost/interprocess/named_sharable_mutex.html +++ b/doc/html/boost/interprocess/named_sharable_mutex.html @@ -36,98 +36,98 @@ <span class="keyword">class</span> <a class="link" href="named_sharable_mutex.html" title="Class named_sharable_mutex">named_sharable_mutex</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="named_sharable_mutex.html#boost.interprocess.named_sharable_mutexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="named_sharable_mutex.html#idp64390864-bb"><span class="identifier">named_sharable_mutex</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_sharable_mutex.html#idp57275456-bb"><span class="identifier">named_sharable_mutex</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_sharable_mutex.html#idp64395904-bb"><span class="identifier">named_sharable_mutex</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_sharable_mutex.html#idp57280496-bb"><span class="identifier">named_sharable_mutex</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_sharable_mutex.html#idp64403248-bb"><span class="identifier">named_sharable_mutex</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_sharable_mutex.html#idp64406336-bb"><span class="special">~</span><span class="identifier">named_sharable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_sharable_mutex.html#idp57287840-bb"><span class="identifier">named_sharable_mutex</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_sharable_mutex.html#idp57290928-bb"><span class="special">~</span><span class="identifier">named_sharable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_sharable_mutex.html#idp64370864-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="named_sharable_mutex.html#idp64371424-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp64373632-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp64375920-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_sharable_mutex.html#idp64378912-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_sharable_mutex.html#idp64381088-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp64383280-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp64385552-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_sharable_mutex.html#idp64388528-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_sharable_mutex.html#idp57255456-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="named_sharable_mutex.html#idp57256016-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp57258224-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp57260512-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_sharable_mutex.html#idp57263504-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_sharable_mutex.html#idp57265680-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp57267872-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp57270144-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_sharable_mutex.html#idp57273120-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_sharable_mutex.html#idp64407376-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp64407936-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_sharable_mutex.html#idp57291968-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_sharable_mutex.html#idp57292528-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp266927104"></a><h2>Description</h2> +<a name="idp285780464"></a><h2>Description</h2> <p>A sharable mutex with a global name, so it can be found from different processes. This mutex can't be placed in shared memory, and each process should have it's own named sharable mutex. </p> <div class="refsect2"> -<a name="idp266927984"></a><h3> +<a name="idp285781344"></a><h3> <a name="boost.interprocess.named_sharable_mutexconstruct-copy-destruct"></a><code class="computeroutput">named_sharable_mutex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64390864-bb"></a><span class="identifier">named_sharable_mutex</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57275456-bb"></a><span class="identifier">named_sharable_mutex</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a global sharable mutex with a name. If the sharable mutex can't be created throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64395904-bb"></a><span class="identifier">named_sharable_mutex</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57280496-bb"></a><span class="identifier">named_sharable_mutex</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Opens or creates a global sharable mutex with a name. If the sharable mutex is created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_sharable_mutex.html" title="Class named_sharable_mutex">named_sharable_mutex</a></code>(<code class="computeroutput"><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a></code>, ...) If the sharable mutex is already created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_sharable_mutex.html" title="Class named_sharable_mutex">named_sharable_mutex</a></code>(<code class="computeroutput"><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a></code>, ... ). </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64403248-bb"></a><span class="identifier">named_sharable_mutex</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57287840-bb"></a><span class="identifier">named_sharable_mutex</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Opens a global sharable mutex with a name if that sharable mutex is previously. created. If it is not previously created this function throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64406336-bb"></a><span class="special">~</span><span class="identifier">named_sharable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57290928-bb"></a><span class="special">~</span><span class="identifier">named_sharable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp266976016"></a><h3> -<a name="idp64370864-bb"></a><code class="computeroutput">named_sharable_mutex</code> public member functions</h3> +<a name="idp285829312"></a><h3> +<a name="idp57255456-bb"></a><code class="computeroutput">named_sharable_mutex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64371424-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57256016-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive or sharable ownership of the mutex, it waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64373632-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57258224-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive or sharable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64375920-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57260512-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, or sharable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64378912-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57263504-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64381088-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57265680-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64383280-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57267872-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64385552-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57270144-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64388528-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57273120-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp267035376"></a><h3> -<a name="idp64407376-bb"></a><code class="computeroutput">named_sharable_mutex</code> public static functions</h3> +<a name="idp285888736"></a><h3> +<a name="idp57291968-bb"></a><code class="computeroutput">named_sharable_mutex</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp64407936-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp57292528-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Erases a named sharable mutex from the system. Returns false on error. Never throws. </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/named_upgradable_mutex.html b/doc/html/boost/interprocess/named_upgradable_mutex.html index ef9b12b91e..489dbf33d9 100644 --- a/doc/html/boost/interprocess/named_upgradable_mutex.html +++ b/doc/html/boost/interprocess/named_upgradable_mutex.html @@ -36,158 +36,158 @@ <span class="keyword">class</span> <a class="link" href="named_upgradable_mutex.html" title="Class named_upgradable_mutex">named_upgradable_mutex</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="named_upgradable_mutex.html#boost.interprocess.named_upgradable_mutexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="named_upgradable_mutex.html#idp64463280-bb"><span class="identifier">named_upgradable_mutex</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_upgradable_mutex.html#idp57347872-bb"><span class="identifier">named_upgradable_mutex</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_upgradable_mutex.html#idp64468320-bb"><span class="identifier">named_upgradable_mutex</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> + <a class="link" href="named_upgradable_mutex.html#idp57352912-bb"><span class="identifier">named_upgradable_mutex</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_upgradable_mutex.html#idp64475664-bb"><span class="identifier">named_upgradable_mutex</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="named_upgradable_mutex.html#idp64478752-bb"><span class="special">~</span><span class="identifier">named_upgradable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_upgradable_mutex.html#idp57360256-bb"><span class="identifier">named_upgradable_mutex</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="named_upgradable_mutex.html#idp57363344-bb"><span class="special">~</span><span class="identifier">named_upgradable_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_upgradable_mutex.html#idp64414112-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64414672-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64416880-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64419184-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64422176-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64424352-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64426544-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64428816-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64431792-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64433968-bb"><span class="identifier">lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64436176-bb"><span class="identifier">try_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64438480-bb"><span class="identifier">timed_lock_upgradable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64441472-bb"><span class="identifier">unlock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64443648-bb"><span class="identifier">unlock_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64445888-bb"><span class="identifier">unlock_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64448128-bb"><span class="identifier">unlock_upgradable_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp64450368-bb"><span class="identifier">unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64452656-bb"><span class="identifier">try_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64455072-bb"><span class="identifier">timed_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64458256-bb"><span class="identifier">try_unlock_sharable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64460688-bb"><span class="identifier">try_unlock_sharable_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_upgradable_mutex.html#idp57298704-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57299264-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57301472-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57303776-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57306768-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57308944-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57311136-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57313408-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57316384-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57318560-bb"><span class="identifier">lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57320768-bb"><span class="identifier">try_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57323072-bb"><span class="identifier">timed_lock_upgradable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57326064-bb"><span class="identifier">unlock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57328240-bb"><span class="identifier">unlock_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57330480-bb"><span class="identifier">unlock_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57332720-bb"><span class="identifier">unlock_upgradable_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="named_upgradable_mutex.html#idp57334960-bb"><span class="identifier">unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57337248-bb"><span class="identifier">try_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57339664-bb"><span class="identifier">timed_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57342848-bb"><span class="identifier">try_unlock_sharable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57345280-bb"><span class="identifier">try_unlock_sharable_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="named_upgradable_mutex.html#idp64479792-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp64480352-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="named_upgradable_mutex.html#idp57364384-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="named_upgradable_mutex.html#idp57364944-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp267195616"></a><h2>Description</h2> +<a name="idp286049120"></a><h2>Description</h2> <p>A upgradable mutex with a global name, so it can be found from different processes. This mutex can't be placed in shared memory, and each process should have it's own named upgradable mutex. </p> <div class="refsect2"> -<a name="idp267196496"></a><h3> +<a name="idp286050000"></a><h3> <a name="boost.interprocess.named_upgradable_mutexconstruct-copy-destruct"></a><code class="computeroutput">named_upgradable_mutex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64463280-bb"></a><span class="identifier">named_upgradable_mutex</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57347872-bb"></a><span class="identifier">named_upgradable_mutex</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a> create_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a global upgradable mutex with a name. If the upgradable mutex can't be created throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64468320-bb"></a><span class="identifier">named_upgradable_mutex</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> +<pre class="literallayout"><a name="idp57352912-bb"></a><span class="identifier">named_upgradable_mutex</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Opens or creates a global upgradable mutex with a name. If the upgradable mutex is created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_upgradable_mutex.html" title="Class named_upgradable_mutex">named_upgradable_mutex</a></code>(<code class="computeroutput"><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a></code>, ...) If the upgradable mutex is already created, this call is equivalent to <code class="computeroutput"><a class="link" href="named_upgradable_mutex.html" title="Class named_upgradable_mutex">named_upgradable_mutex</a></code>(<code class="computeroutput"><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a></code>, ... ). </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64475664-bb"></a><span class="identifier">named_upgradable_mutex</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57360256-bb"></a><span class="identifier">named_upgradable_mutex</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Opens a global upgradable mutex with a name if that upgradable mutex is previously. created. If it is not previously created this function throws <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64478752-bb"></a><span class="special">~</span><span class="identifier">named_upgradable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57363344-bb"></a><span class="special">~</span><span class="identifier">named_upgradable_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp267244528"></a><h3> -<a name="idp64414112-bb"></a><code class="computeroutput">named_upgradable_mutex</code> public member functions</h3> +<a name="idp286098160"></a><h3> +<a name="idp57298704-bb"></a><code class="computeroutput">named_upgradable_mutex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64414672-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57299264-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain exclusive ownership of the mutex, and if another thread has exclusive, sharable or upgradable ownership of the mutex, it waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64416880-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57301472-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex without waiting. If no other thread has exclusive, sharable or upgradable ownership of the mutex this succeeds. Returns: If it can acquire exclusive ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64419184-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57303776-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire exclusive ownership of the mutex waiting if necessary until no other thread has exclusive, sharable or upgradable ownership of the mutex or abs_time is reached. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64422176-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57306768-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The calling thread releases the exclusive ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64424352-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57308944-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain sharable ownership of the mutex, and if another thread has exclusive ownership of the mutex, waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64426544-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57311136-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex without waiting. If no other thread has exclusive ownership of the mutex this succeeds. Returns: If it can acquire sharable ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64428816-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57313408-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire sharable ownership of the mutex waiting if necessary until no other thread has exclusive ownership of the mutex or abs_time is reached. Returns: If acquires sharable ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64431792-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57316384-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have sharable ownership of the mutex. Effects: The calling thread releases the sharable ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64433968-bb"></a><span class="identifier">lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57318560-bb"></a><span class="identifier">lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to obtain upgradable ownership of the mutex, and if another thread has exclusive or upgradable ownership of the mutex, waits until it can obtain the ownership. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64436176-bb"></a><span class="identifier">try_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57320768-bb"></a><span class="identifier">try_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire upgradable ownership of the mutex without waiting. If no other thread has exclusive or upgradable ownership of the mutex this succeeds. Returns: If it can acquire upgradable ownership immediately returns true. If it has to wait, returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64438480-bb"></a><span class="identifier">timed_lock_upgradable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57323072-bb"></a><span class="identifier">timed_lock_upgradable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: The calling thread tries to acquire upgradable ownership of the mutex waiting if necessary until no other thread has exclusive or upgradable ownership of the mutex or abs_time is reached. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64441472-bb"></a><span class="identifier">unlock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57326064-bb"></a><span class="identifier">unlock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The calling thread releases the upgradable ownership of the mutex. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64443648-bb"></a><span class="identifier">unlock_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57328240-bb"></a><span class="identifier">unlock_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The thread atomically releases exclusive ownership and acquires upgradable ownership. This operation is non-blocking. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64445888-bb"></a><span class="identifier">unlock_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57330480-bb"></a><span class="identifier">unlock_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have exclusive ownership of the mutex. Effects: The thread atomically releases exclusive ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64448128-bb"></a><span class="identifier">unlock_upgradable_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57332720-bb"></a><span class="identifier">unlock_upgradable_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and acquires sharable ownership. This operation is non-blocking. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64450368-bb"></a><span class="identifier">unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57334960-bb"></a><span class="identifier">unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and acquires exclusive ownership. This operation will block until all threads with sharable ownership release it. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64452656-bb"></a><span class="identifier">try_unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57337248-bb"></a><span class="identifier">try_unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable ownership, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64455072-bb"></a><span class="identifier">timed_unlock_upgradable_and_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57339664-bb"></a><span class="identifier">timed_unlock_upgradable_and_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have upgradable ownership of the mutex. Effects: The thread atomically releases upgradable ownership and tries to acquire exclusive ownership, waiting if necessary until abs_time. This operation will fail if there are threads with sharable ownership or timeout reaches, but it will maintain upgradable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64458256-bb"></a><span class="identifier">try_unlock_sharable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57342848-bb"></a><span class="identifier">try_unlock_sharable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have sharable ownership of the mutex. Effects: The thread atomically releases sharable ownership and tries to acquire exclusive ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires exclusive ownership, returns true. Otherwise returns false. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64460688-bb"></a><span class="identifier">try_unlock_sharable_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57345280-bb"></a><span class="identifier">try_unlock_sharable_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Precondition: The thread must have sharable ownership of the mutex. Effects: The thread atomically releases sharable ownership and tries to acquire upgradable ownership. This operation will fail if there are threads with sharable or upgradable ownership, but it will maintain sharable ownership. Returns: If acquires upgradable ownership, returns true. Otherwise returns false. Throws: An exception derived from <code class="computeroutput"><a class="link" href="interprocess_exception.html" title="Class interprocess_exception">interprocess_exception</a></code> on error. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp267386448"></a><h3> -<a name="idp64479792-bb"></a><code class="computeroutput">named_upgradable_mutex</code> public static functions</h3> +<a name="idp286240032"></a><h3> +<a name="idp57364384-bb"></a><code class="computeroutput">named_upgradable_mutex</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp64480352-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp57364944-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Erases a named upgradable mutex from the system. Returns false on error. Never throws. </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/node_allocator.html b/doc/html/boost/interprocess/node_allocator.html index 7d649fcae0..82f5705256 100644 --- a/doc/html/boost/interprocess/node_allocator.html +++ b/doc/html/boost/interprocess/node_allocator.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.node_allocator_hpp" title="Header <boost/interprocess/allocators/node_allocator.hpp>"> -<link rel="prev" href="operator___idp61937136.html" title="Function template operator!="> +<link rel="prev" href="operator___idp54821728.html" title="Function template operator!="> <link rel="next" href="node_allocator/rebind.html" title="Struct template rebind"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61937136.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> +<a accesskey="p" href="operator___idp54821728.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> </div> <div class="refentry"> <a name="boost.interprocess.node_allocator"></a><div class="titlepage"></div> @@ -54,164 +54,164 @@ <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="node_allocator.html#boost.interprocess.node_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="node_allocator.html#idp62016112-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="node_allocator.html#idp62019136-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="node_allocator.html#idp54900704-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="node_allocator.html#idp54903728-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> - <a class="link" href="node_allocator.html#idp62021792-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="node_allocator.html#idp54906384-bb"><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> SegmentManager2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N2<span class="special">></span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span> - <a class="link" href="node_allocator.html#idp61963504-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="node_allocator.html#idp62026096-bb"><span class="special">~</span><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="node_allocator.html#idp54848096-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="node_allocator.html#idp54910688-bb"><span class="special">~</span><span class="identifier">node_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="node_allocator.html#idp61968944-bb">public member functions</a></span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="node_allocator.html#idp61969504-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="node_allocator.html#idp61971072-bb"><span class="identifier">get_segment_manager</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#idp61972640-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp61974224-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">cvoid_pointer</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp61977952-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp61980624-bb"><span class="identifier">deallocate_free_blocks</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp61981920-bb"><span class="identifier">address</span></a><span class="special">(</span><span class="identifier">reference</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">const_pointer</span> <a class="link" href="node_allocator.html#idp61984176-bb"><span class="identifier">address</span></a><span class="special">(</span><span class="identifier">const_reference</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp61986432-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp61989120-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#idp61991104-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">pointer</span> <a class="link" href="node_allocator.html#idp61993504-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="comment">// <a class="link" href="node_allocator.html#idp54853536-bb">public member functions</a></span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="node_allocator.html#idp54854096-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="node_allocator.html#idp54855664-bb"><span class="identifier">get_segment_manager</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#idp54857232-bb"><span class="identifier">max_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp54858816-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">cvoid_pointer</span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54862544-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54865216-bb"><span class="identifier">deallocate_free_blocks</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp54866512-bb"><span class="identifier">address</span></a><span class="special">(</span><span class="identifier">reference</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">const_pointer</span> <a class="link" href="node_allocator.html#idp54868768-bb"><span class="identifier">address</span></a><span class="special">(</span><span class="identifier">const_reference</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54871024-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">const_reference</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54873712-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="node_allocator.html#idp54875696-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">pointer</span> <a class="link" href="node_allocator.html#idp54878096-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="special">,</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp61997136-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> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp62000768-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> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp62004208-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> - <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp62006464-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp62008592-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">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp62011552-bb"><span class="identifier">deallocate_one</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp62013680-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="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54881728-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> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54885360-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> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54888800-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> + <span class="identifier">pointer</span> <a class="link" href="node_allocator.html#idp54891056-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54893184-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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54896144-bb"><span class="identifier">deallocate_one</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54898272-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="special">;</span> - <span class="comment">// <a class="link" href="node_allocator.html#idp62026880-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp62027440-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="node_allocator.html#idp54911472-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="node_allocator.html#idp54912032-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="idp252896272"></a><h2>Description</h2> +<a name="idp271747184"></a><h2>Description</h2> <p>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc... This node allocator shares a segregated storage between all instances of <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> with equal sizeof(T) placed in the same segment group. NodesPerBlock is the number of nodes allocated at once when the allocator runs out of nodes </p> <div class="refsect2"> -<a name="idp252898336"></a><h3> +<a name="idp271749248"></a><h3> <a name="boost.interprocess.node_allocatorconstruct-copy-destruct"></a><code class="computeroutput">node_allocator</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62016112-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54900704-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from other <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code> Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62019136-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54903728-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from other <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code>. Increments the reference count of the associated node pool. Never throws </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> - <a name="idp62021792-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> + <a name="idp54906384-bb"></a><span class="identifier">node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from related <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> SegmentManager2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N2<span class="special">></span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a> <span class="special">&</span> - <a name="idp61963504-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp54848096-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from related <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62026096-bb"></a><span class="special">~</span><span class="identifier">node_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp54910688-bb"></a><span class="special">~</span><span class="identifier">node_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destructor, removes node_pool_t from memory if its reference count reaches to zero. Never throws </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp252956032"></a><h3> -<a name="idp61968944-bb"></a><code class="computeroutput">node_allocator</code> public member functions</h3> +<a name="idp271806800"></a><h3> +<a name="idp54853536-bb"></a><code class="computeroutput">node_allocator</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp61969504-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp54854096-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a pointer to the node pool. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp61971072-bb"></a><span class="identifier">get_segment_manager</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp54855664-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="idp61972640-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54857232-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="idp61974224-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54858816-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocate memory for an array of count elements. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61977952-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54862544-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="idp61980624-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54865216-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="idp61981920-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54866512-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="idp61984176-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">const_reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idp54868768-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="idp61986432-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54871024-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> <p>Copy construct an object. Throws if T's copy constructor throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61989120-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54873712-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="idp61991104-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54875696-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">pointer</span> <a name="idp61993504-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> +<li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54878096-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> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">pointer</span> <span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp61997136-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54881728-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">size_type</span> num_elements<span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&</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="keyword">void</span> <a name="idp62000768-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54885360-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<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="idp62004208-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54888800-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> <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="idp62006464-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54891056-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62008592-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54893184-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<span class="special">)</span><span class="special">;</span></pre> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62011552-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54896144-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="idp62013680-bb"></a><span class="identifier">deallocate_individual</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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54898272-bb"></a><span class="identifier">deallocate_individual</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> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp253096496"></a><h3> -<a name="idp62026880-bb"></a><code class="computeroutput">node_allocator</code> friend functions</h3> +<a name="idp271947200"></a><h3> +<a name="idp54911472-bb"></a><code class="computeroutput">node_allocator</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp62027440-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp54912032-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> @@ -227,7 +227,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61937136.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> +<a accesskey="p" href="operator___idp54821728.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> </div> </body> </html> diff --git a/doc/html/boost/interprocess/node_allocator/rebind.html b/doc/html/boost/interprocess/node_allocator/rebind.html index f00688a19f..74cf5ab762 100644 --- a/doc/html/boost/interprocess/node_allocator/rebind.html +++ b/doc/html/boost/interprocess/node_allocator/rebind.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../node_allocator.html#idp252896272" title="Description"> +<link rel="up" href="../node_allocator.html#idp271747184" title="Description"> <link rel="prev" href="../node_allocator.html" title="Class template node_allocator"> -<link rel="next" href="../operator___idp62030496.html" title="Function template operator=="> +<link rel="next" href="../operator___idp54915088.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../node_allocator.html#idp252896272"><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="../operator___idp62030496.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../node_allocator.html#idp271747184"><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="../operator___idp54915088.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.node_allocator.rebind"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <span class="keyword">typedef</span> <a class="link" href="../node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <a name="boost.interprocess.node_allocator.rebind.other"></a><span class="identifier">other</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp253125792"></a><h2>Description</h2> +<a name="idp271976368"></a><h2>Description</h2> <p>Obtains <a class="link" href="../node_allocator.html" title="Class template node_allocator">node_allocator</a> from <a class="link" href="../node_allocator.html" title="Class template node_allocator">node_allocator</a> </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../node_allocator.html#idp252896272"><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="../operator___idp62030496.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../node_allocator.html#idp271747184"><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="../operator___idp54915088.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/null_index.html b/doc/html/boost/interprocess/null_index.html index 2ef8ebdbca..a176a4ae69 100644 --- a/doc/html/boost/interprocess/null_index.html +++ b/doc/html/boost/interprocess/null_index.html @@ -40,43 +40,43 @@ <span class="keyword">typedef</span> <span class="keyword">const</span> <span class="keyword">int</span> <span class="special">*</span> <a name="boost.interprocess.null_index.const_iterator"></a><span class="identifier">const_iterator</span><span class="special">;</span> <span class="comment">// <a class="link" href="null_index.html#boost.interprocess.null_indexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="null_index.html#idp62459424-bb"><span class="identifier">null_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="null_index.html#idp55344016-bb"><span class="identifier">null_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="null_index.html#idp62453040-bb">public member functions</a></span> - <span class="identifier">const_iterator</span> <a class="link" href="null_index.html#idp62453600-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">iterator</span> <a class="link" href="null_index.html#idp62455152-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">const_iterator</span> <a class="link" href="null_index.html#idp62456432-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">iterator</span> <a class="link" href="null_index.html#idp62457984-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="null_index.html#idp55337632-bb">public member functions</a></span> + <span class="identifier">const_iterator</span> <a class="link" href="null_index.html#idp55338192-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="null_index.html#idp55339744-bb"><span class="identifier">begin</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_iterator</span> <a class="link" href="null_index.html#idp55341024-bb"><span class="identifier">end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">iterator</span> <a class="link" href="null_index.html#idp55342576-bb"><span class="identifier">end</span></a><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="idp255563376"></a><h2>Description</h2> +<a name="idp274413968"></a><h2>Description</h2> <p>Null index type used to save compilation time when named indexes are not needed. </p> <div class="refsect2"> -<a name="idp255564144"></a><h3> +<a name="idp274414736"></a><h3> <a name="boost.interprocess.null_indexconstruct-copy-destruct"></a><code class="computeroutput">null_index</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp62459424-bb"></a><span class="identifier">null_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span></pre>Empty constructor. </li></ol></div> +<pre class="literallayout"><a name="idp55344016-bb"></a><span class="identifier">null_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span></pre>Empty constructor. </li></ol></div> </div> <div class="refsect2"> -<a name="idp255571456"></a><h3> -<a name="idp62453040-bb"></a><code class="computeroutput">null_index</code> public member functions</h3> +<a name="idp274422176"></a><h3> +<a name="idp55337632-bb"></a><code class="computeroutput">null_index</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp62453600-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp55338192-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>begin() is equal to end() </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp62455152-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp55339744-bb"></a><span class="identifier">begin</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>begin() is equal to end() </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp62456432-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_iterator</span> <a name="idp55341024-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>begin() is equal to end() </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp62457984-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">iterator</span> <a name="idp55342576-bb"></a><span class="identifier">end</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>begin() is equal to end() </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/null_mutex.html b/doc/html/boost/interprocess/null_mutex.html index db0327d1a5..073614fd2e 100644 --- a/doc/html/boost/interprocess/null_mutex.html +++ b/doc/html/boost/interprocess/null_mutex.html @@ -36,130 +36,130 @@ <span class="keyword">class</span> <a class="link" href="null_mutex.html" title="Class null_mutex">null_mutex</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="null_mutex.html#boost.interprocess.null_mutexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="null_mutex.html#idp64516224-bb"><span class="identifier">null_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="null_mutex.html#idp64516928-bb"><span class="special">~</span><span class="identifier">null_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="null_mutex.html#idp57400816-bb"><span class="identifier">null_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="null_mutex.html#idp57401520-bb"><span class="special">~</span><span class="identifier">null_mutex</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="null_mutex.html#idp64486384-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64486944-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64488112-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64489424-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64491440-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64492736-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64494048-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64495376-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64497408-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64498720-bb"><span class="identifier">lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64500032-bb"><span class="identifier">try_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64501360-bb"><span class="identifier">timed_lock_upgradable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64503392-bb"><span class="identifier">unlock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64504704-bb"><span class="identifier">unlock_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64506032-bb"><span class="identifier">unlock_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64507344-bb"><span class="identifier">unlock_upgradable_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp64508672-bb"><span class="identifier">unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64510000-bb"><span class="identifier">try_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64511344-bb"><span class="identifier">timed_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64513392-bb"><span class="identifier">try_unlock_sharable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp64514720-bb"><span class="identifier">try_unlock_sharable_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="null_mutex.html#idp57370976-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57371536-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57372704-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57374016-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57376032-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57377328-bb"><span class="identifier">lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57378640-bb"><span class="identifier">try_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57379968-bb"><span class="identifier">timed_lock_sharable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57382000-bb"><span class="identifier">unlock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57383312-bb"><span class="identifier">lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57384624-bb"><span class="identifier">try_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57385952-bb"><span class="identifier">timed_lock_upgradable</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57387984-bb"><span class="identifier">unlock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57389296-bb"><span class="identifier">unlock_and_lock_upgradable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57390624-bb"><span class="identifier">unlock_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57391936-bb"><span class="identifier">unlock_upgradable_and_lock_sharable</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="null_mutex.html#idp57393264-bb"><span class="identifier">unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57394592-bb"><span class="identifier">try_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57395936-bb"><span class="identifier">timed_unlock_upgradable_and_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57397984-bb"><span class="identifier">try_unlock_sharable_and_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="null_mutex.html#idp57399312-bb"><span class="identifier">try_unlock_sharable_and_lock_upgradable</span></a><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="idp267512752"></a><h2>Description</h2> +<a name="idp286366000"></a><h2>Description</h2> <p>Implements a mutex that simulates a mutex without doing any operation and simulates a successful operation. </p> <div class="refsect2"> -<a name="idp267513552"></a><h3> +<a name="idp286366800"></a><h3> <a name="boost.interprocess.null_mutexconstruct-copy-destruct"></a><code class="computeroutput">null_mutex</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64516224-bb"></a><span class="identifier">null_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57400816-bb"></a><span class="identifier">null_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Empty. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64516928-bb"></a><span class="special">~</span><span class="identifier">null_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57401520-bb"></a><span class="special">~</span><span class="identifier">null_mutex</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destructor. Empty. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp267524096"></a><h3> -<a name="idp64486384-bb"></a><code class="computeroutput">null_mutex</code> public member functions</h3> +<a name="idp286377408"></a><h3> +<a name="idp57370976-bb"></a><code class="computeroutput">null_mutex</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64486944-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Simulates a mutex lock() operation. Empty function. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57371536-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Simulates a mutex lock() operation. Empty function. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64488112-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57372704-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex try_lock() operation. Equivalent to "return true;" </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64489424-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57374016-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex timed_lock() operation. Equivalent to "return true;" </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64491440-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57376032-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex unlock() operation. Empty function. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64492736-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57377328-bb"></a><span class="identifier">lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex lock_sharable() operation. Empty function. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64494048-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57378640-bb"></a><span class="identifier">try_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex try_lock_sharable() operation. Equivalent to "return true;" </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64495376-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57379968-bb"></a><span class="identifier">timed_lock_sharable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex timed_lock_sharable() operation. Equivalent to "return true;" </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64497408-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57382000-bb"></a><span class="identifier">unlock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex unlock_sharable() operation. Empty function. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64498720-bb"></a><span class="identifier">lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57383312-bb"></a><span class="identifier">lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex lock_upgradable() operation. Empty function. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64500032-bb"></a><span class="identifier">try_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57384624-bb"></a><span class="identifier">try_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex try_lock_upgradable() operation. Equivalent to "return true;" </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64501360-bb"></a><span class="identifier">timed_lock_upgradable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57385952-bb"></a><span class="identifier">timed_lock_upgradable</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex timed_lock_upgradable() operation. Equivalent to "return true;" </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64503392-bb"></a><span class="identifier">unlock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57387984-bb"></a><span class="identifier">unlock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates a mutex unlock_upgradable() operation. Empty function. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64504704-bb"></a><span class="identifier">unlock_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57389296-bb"></a><span class="identifier">unlock_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates unlock_and_lock_upgradable(). Empty function. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64506032-bb"></a><span class="identifier">unlock_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57390624-bb"></a><span class="identifier">unlock_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates unlock_and_lock_sharable(). Empty function. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64507344-bb"></a><span class="identifier">unlock_upgradable_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57391936-bb"></a><span class="identifier">unlock_upgradable_and_lock_sharable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates unlock_upgradable_and_lock_sharable(). Empty function. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64508672-bb"></a><span class="identifier">unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57393264-bb"></a><span class="identifier">unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates unlock_upgradable_and_lock(). Empty function. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64510000-bb"></a><span class="identifier">try_unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57394592-bb"></a><span class="identifier">try_unlock_upgradable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates try_unlock_upgradable_and_lock(). Equivalent to "return true;" </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64511344-bb"></a><span class="identifier">timed_unlock_upgradable_and_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57395936-bb"></a><span class="identifier">timed_unlock_upgradable_and_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates timed_unlock_upgradable_and_lock(). Equivalent to "return true;" </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64513392-bb"></a><span class="identifier">try_unlock_sharable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57397984-bb"></a><span class="identifier">try_unlock_sharable_and_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates try_unlock_sharable_and_lock(). Equivalent to "return true;" </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64514720-bb"></a><span class="identifier">try_unlock_sharable_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57399312-bb"></a><span class="identifier">try_unlock_sharable_and_lock_upgradable</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Simulates try_unlock_sharable_and_lock_upgradable(). Equivalent to "return true;" </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/null_mutex_family.html b/doc/html/boost/interprocess/null_mutex_family.html index 62fa9dfe90..d594236650 100644 --- a/doc/html/boost/interprocess/null_mutex_family.html +++ b/doc/html/boost/interprocess/null_mutex_family.html @@ -39,7 +39,7 @@ <span class="keyword">typedef</span> <a class="link" href="null_mutex.html" title="Class null_mutex">boost::interprocess::null_mutex</a> <a name="boost.interprocess.null_mutex_family.recursive_mutex_type"></a><span class="identifier">recursive_mutex_type</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp265832560"></a><h2>Description</h2> +<a name="idp284685584"></a><h2>Description</h2> <p>Describes <a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a> family to use with Interprocess frameworks based on null operation synchronization objects. </p> </div> </div> diff --git a/doc/html/boost/interprocess/offset_ptr.html b/doc/html/boost/interprocess/offset_ptr.html index eea7d76b23..f4fc51eb70 100644 --- a/doc/html/boost/interprocess/offset_ptr.html +++ b/doc/html/boost/interprocess/offset_ptr.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_hpp" title="Header <boost/interprocess/offset_ptr.hpp>"> <link rel="prev" href="simple_seq_fit.html" title="Class template simple_seq_fit"> -<link rel="next" href="operator_idp63103520.html" title="Function template operator<<"> +<link rel="next" href="operator_idp55988112.html" title="Function template operator<<"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="simple_seq_fit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="operator_idp63103520.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="simple_seq_fit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="operator_idp55988112.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.offset_ptr"></a><div class="titlepage"></div> @@ -47,64 +47,64 @@ <span class="keyword">typedef</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <a class="link" href="offset_ptr.html#boost.interprocess.offset_ptr.rebind"><span class="identifier">rebind</span></a><span class="special">;</span> <span class="comment">// <a class="link" href="offset_ptr.html#boost.interprocess.offset_ptrconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="offset_ptr.html#idp63019488-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html#idp63020496-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="offset_ptr.html#idp63022224-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html#idp63025872-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55904080-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55905088-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="offset_ptr.html#idp55906816-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55910464-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</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="offset_ptr.html#idp63028720-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55913312-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</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">explicit</span> <a class="link" href="offset_ptr.html#idp63032528-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="offset_ptr.html#idp55917120-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</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> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> - <a class="link" href="offset_ptr.html#idp63036672-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55921264-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</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> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> - <a class="link" href="offset_ptr.html#idp63042448-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55927040-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</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> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> - <a class="link" href="offset_ptr.html#idp63048224-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55932816-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</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> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> - <a class="link" href="offset_ptr.html#idp63054000-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp63059776-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp63062064-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55938592-bb"><span class="identifier">offset_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp55944368-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">pointer</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp55946656-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</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="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> - <a class="link" href="offset_ptr.html#idp63065488-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55950080-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="comment">// <a class="link" href="offset_ptr.html#idp62989216-bb">public member functions</a></span> - <span class="identifier">pointer</span> <a class="link" href="offset_ptr.html#idp62989776-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="identifier">offset_type</span> <a class="link" href="offset_ptr.html#idp62991344-bb"><span class="identifier">get_offset</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="identifier">pointer</span> <a class="link" href="offset_ptr.html#idp62992464-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="identifier">reference</span> <a class="link" href="offset_ptr.html#idp62994048-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="identifier">reference</span> <a class="link" href="offset_ptr.html#idp62996368-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp62998608-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp63001712-bb"><span class="keyword">operator</span><span class="special">-=</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp63004816-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp63007344-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp63009712-bb"><span class="keyword">operator</span><span class="special">--</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp63012960-bb"><span class="keyword">operator</span><span class="special">--</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="offset_ptr.html#idp63015888-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="offset_ptr.html#idp63017728-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="comment">// <a class="link" href="offset_ptr.html#idp55873808-bb">public member functions</a></span> + <span class="identifier">pointer</span> <a class="link" href="offset_ptr.html#idp55874368-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="identifier">offset_type</span> <a class="link" href="offset_ptr.html#idp55875936-bb"><span class="identifier">get_offset</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="offset_ptr.html#idp55877056-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="offset_ptr.html#idp55878640-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="offset_ptr.html#idp55880960-bb"><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp55883200-bb"><span class="keyword">operator</span><span class="special">+=</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp55886304-bb"><span class="keyword">operator</span><span class="special">-=</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp55889408-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp55891936-bb"><span class="keyword">operator</span><span class="special">++</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a class="link" href="offset_ptr.html#idp55894304-bb"><span class="keyword">operator</span><span class="special">--</span></a><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp55897552-bb"><span class="keyword">operator</span><span class="special">--</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="offset_ptr.html#idp55900480-bb"><span class="keyword">operator</span> <span class="keyword">bool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="offset_ptr.html#idp55902320-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="comment">// <a class="link" href="offset_ptr.html#idp63069888-bb">public static functions</a></span> - <span class="keyword">static</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp63070448-bb"><span class="identifier">pointer_to</span></a><span class="special">(</span><span class="identifier">reference</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="comment">// <a class="link" href="offset_ptr.html#idp55954480-bb">public static functions</a></span> + <span class="keyword">static</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp55955040-bb"><span class="identifier">pointer_to</span></a><span class="special">(</span><span class="identifier">reference</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="comment">// <a class="link" href="offset_ptr.html#idp63073248-bb">friend functions</a></span> - <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp63073808-bb"><span class="keyword">operator</span><span class="special">+</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp63077872-bb"><span class="keyword">operator</span><span class="special">+</span></a><span class="special">(</span><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special">,</span> <span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp63081792-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special">,</span> <span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp63085696-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="comment">// <a class="link" href="offset_ptr.html#idp55957840-bb">friend functions</a></span> + <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp55958400-bb"><span class="keyword">operator</span><span class="special">+</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp55962464-bb"><span class="keyword">operator</span><span class="special">+</span></a><span class="special">(</span><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special">,</span> <span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp55966384-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special">,</span> <span class="identifier">difference_type</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a class="link" href="offset_ptr.html#idp55970288-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="identifier">difference_type</span><span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> <span class="keyword">friend</span> <span class="identifier">difference_type</span> - <a class="link" href="offset_ptr.html#idp63089600-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> + <a class="link" href="offset_ptr.html#idp55974192-bb"><span class="keyword">operator</span><span class="special">-</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> - <span class="comment">// <a class="link" href="offset_ptr.html#idp63094880-bb">private member functions</a></span> + <span class="comment">// <a class="link" href="offset_ptr.html#idp55979472-bb">private member functions</a></span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> - <span class="keyword">void</span> <a class="link" href="offset_ptr.html#idp63095456-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> + <span class="keyword">void</span> <a class="link" href="offset_ptr.html#idp55980048-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</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">void</span> <a class="link" href="offset_ptr.html#idp63099408-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> + <span class="keyword">void</span> <a class="link" href="offset_ptr.html#idp55984000-bb"><span class="identifier">assign</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp258869200"></a><h2>Description</h2> +<a name="idp277719456"></a><h2>Description</h2> <p>A smart pointer that stores the offset between between the pointer and the the object it points. This allows offset allows special properties, since the pointer is independent from the address of the pointee, if the pointer and the pointee are still separated by the same offset. This feature converts <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> in a smart pointer that can be placed in shared memory and memory mapped files mapped in different addresses in every process.</p> <p> b>Note: <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> uses implementation defined properties, present in most platforms, for performance reasons:</p> @@ -115,7 +115,7 @@ b>Note: <a class="link" href="offset_ptr.html" title="Class template offset_p <p> </p> <div class="refsect2"> -<a name="idp258873808"></a><h3>Template Parameters</h3> +<a name="idp277724064"></a><h3>Template Parameters</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> <pre class="literallayout"><span class="keyword">typename</span> PointedType</pre> @@ -136,7 +136,7 @@ b>Note: <a class="link" href="offset_ptr.html" title="Class template offset_p </ol></div> </div> <div class="refsect2"> -<a name="idp258884672"></a><h3> +<a name="idp277734928"></a><h3> <a name="boost.interprocess.offset_ptrtypes"></a><code class="computeroutput">offset_ptr</code> public types</h3> @@ -147,172 +147,172 @@ b>Note: <a class="link" href="offset_ptr.html" title="Class template offset_p </li></ol></div> </div> <div class="refsect2"> -<a name="idp258896368"></a><h3> +<a name="idp277746560"></a><h3> <a name="boost.interprocess.offset_ptrconstruct-copy-destruct"></a><code class="computeroutput">offset_ptr</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63019488-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55904080-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Default constructor (null pointer). Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63020496-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="identifier">pointer</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55905088-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="identifier">pointer</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Constructor from raw pointer (allows "0" pointer conversion). Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a name="idp63022224-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> ptr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a name="idp55906816-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="identifier">T</span> <span class="special">*</span> ptr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Constructor from other pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63025872-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55910464-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Constructor from other <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> 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="idp63028720-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> + <a name="idp55913312-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Constructor from other <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code>. Only takes part in overload resolution if T2* is convertible to PointedType*. 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> - <span class="keyword">explicit</span> <a name="idp63032528-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> + <span class="keyword">explicit</span> <a name="idp55917120-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Constructor from other <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code>. Only takes part in overload resolution if PointedType* is constructible from T2* other than via a conversion (e.g. cast to a derived class). 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> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> - <a name="idp63036672-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> + <a name="idp55921264-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Emulates static_cast operator. 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> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> - <a name="idp63042448-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> + <a name="idp55927040-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Emulates const_cast operator. 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> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> - <a name="idp63048224-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> + <a name="idp55932816-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Emulates dynamic_cast operator. 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> <span class="keyword">typename</span> P2<span class="special">,</span> <span class="keyword">typename</span> O2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> A2<span class="special">></span> - <a name="idp63054000-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> + <a name="idp55938592-bb"></a><span class="identifier">offset_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">P2</span><span class="special">,</span> <span class="identifier">O2</span><span class="special">,</span> <span class="identifier">A2</span> <span class="special">></span> <span class="special">&</span> r<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Emulates reinterpret_cast operator. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp63059776-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">pointer</span> from<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp55944368-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">pointer</span> from<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Assignment from pointer (saves extra conversion). Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp63062064-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp55946656-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Assignment from other <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code>. 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 class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> - <a name="idp63065488-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> + <a name="idp55950080-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Assignment from related <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code>. If pointers of pointee types are assignable, offset_ptrs will be assignable. Never throws. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp259081360"></a><h3> -<a name="idp62989216-bb"></a><code class="computeroutput">offset_ptr</code> public member functions</h3> +<a name="idp277931808"></a><h3> +<a name="idp55873808-bb"></a><code class="computeroutput">offset_ptr</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp62989776-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp55874368-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Obtains raw pointer from offset. Never throws. </p> </li> -<li class="listitem"><pre class="literallayout"><span class="identifier">offset_type</span> <a name="idp62991344-bb"></a><span class="identifier">get_offset</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="identifier">offset_type</span> <a name="idp55875936-bb"></a><span class="identifier">get_offset</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp62992464-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp55877056-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Pointer-like -> operator. It can return 0 pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">reference</span> <a name="idp62994048-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">reference</span> <a name="idp55878640-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Dereferencing operator, if it is a null <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> behavior is undefined. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">reference</span> <a name="idp62996368-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">difference_type</span> idx<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">reference</span> <a name="idp55880960-bb"></a><span class="keyword">operator</span><span class="special">[</span><span class="special">]</span><span class="special">(</span><span class="identifier">difference_type</span> idx<span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Indexing operator. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp62998608-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="identifier">difference_type</span> offset<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp55883200-bb"></a><span class="keyword">operator</span><span class="special">+=</span><span class="special">(</span><span class="identifier">difference_type</span> offset<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> += difference_type. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp63001712-bb"></a><span class="keyword">operator</span><span class="special">-=</span><span class="special">(</span><span class="identifier">difference_type</span> offset<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp55886304-bb"></a><span class="keyword">operator</span><span class="special">-=</span><span class="special">(</span><span class="identifier">difference_type</span> offset<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> -= difference_type. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp63004816-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp55889408-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>++offset_ptr. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp63007344-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp55891936-bb"></a><span class="keyword">operator</span><span class="special">++</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>offset_ptr++. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp63009712-bb"></a><span class="keyword">operator</span><span class="special">--</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> <a name="idp55894304-bb"></a><span class="keyword">operator</span><span class="special">--</span><span class="special">(</span><span class="keyword">void</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>–<code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code>. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp63012960-bb"></a><span class="keyword">operator</span><span class="special">--</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp55897552-bb"></a><span class="keyword">operator</span><span class="special">--</span><span class="special">(</span><span class="keyword">int</span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code>–. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp63015888-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp55900480-bb"></a><span class="keyword">operator</span> <span class="keyword">bool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>safe bool conversion operator. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63017728-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55902320-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Not operator. Not needed in theory, but improves portability. Never throws </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp259177072"></a><h3> -<a name="idp63069888-bb"></a><code class="computeroutput">offset_ptr</code> public static functions</h3> +<a name="idp278027712"></a><h3> +<a name="idp55954480-bb"></a><code class="computeroutput">offset_ptr</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp63070448-bb"></a><span class="identifier">pointer_to</span><span class="special">(</span><span class="identifier">reference</span> r<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp55955040-bb"></a><span class="identifier">pointer_to</span><span class="special">(</span><span class="identifier">reference</span> r<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>Compatibility with pointer_traits </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp259186032"></a><h3> -<a name="idp63073248-bb"></a><code class="computeroutput">offset_ptr</code> friend functions</h3> +<a name="idp278036592"></a><h3> +<a name="idp55957840-bb"></a><code class="computeroutput">offset_ptr</code> friend functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp63073808-bb"></a><span class="keyword">operator</span><span class="special">+</span><span class="special">(</span><span class="identifier">difference_type</span> diff<span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp55958400-bb"></a><span class="keyword">operator</span><span class="special">+</span><span class="special">(</span><span class="identifier">difference_type</span> diff<span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p>difference_type + <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> operation </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp63077872-bb"></a><span class="keyword">operator</span><span class="special">+</span><span class="special">(</span><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> left<span class="special">,</span> <span class="identifier">difference_type</span> diff<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp55962464-bb"></a><span class="keyword">operator</span><span class="special">+</span><span class="special">(</span><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> left<span class="special">,</span> <span class="identifier">difference_type</span> diff<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> + difference_type operation </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp63081792-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> left<span class="special">,</span> <span class="identifier">difference_type</span> diff<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp55966384-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> left<span class="special">,</span> <span class="identifier">difference_type</span> diff<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> - diff operation </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp63085696-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="identifier">difference_type</span> diff<span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <a name="idp55970288-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="identifier">difference_type</span> diff<span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> right<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> - diff operation </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">friend</span> <span class="identifier">difference_type</span> -<a name="idp63089600-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> pt<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> pt2<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> +<a name="idp55974192-bb"></a><span class="keyword">operator</span><span class="special">-</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> pt<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a> <span class="special">&</span> pt2<span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre> <p><code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> - <code class="computeroutput"><a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a></code> operation </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp259242288"></a><h3> -<a name="idp63094880-bb"></a><code class="computeroutput">offset_ptr</code> private member functions</h3> +<a name="idp278092832"></a><h3> +<a name="idp55979472-bb"></a><code class="computeroutput">offset_ptr</code> private member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <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">void</span> <a name="idp63095456-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">,</span> + <span class="keyword">void</span> <a name="idp55980048-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></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">void</span> <a name="idp63099408-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">,</span> + <span class="keyword">void</span> <a name="idp55984000-bb"></a><span class="identifier">assign</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">DifferenceType</span><span class="special">,</span> <span class="identifier">OffsetType</span><span class="special">,</span> <span class="identifier">OffsetAlignment</span> <span class="special">></span> <span class="special">&</span> ptr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span><span class="special">)</span> <span class="keyword">noexcept</span><span class="special">;</span></pre></li> </ol></div> </div> @@ -328,7 +328,7 @@ b>Note: <a class="link" href="offset_ptr.html" title="Class template offset_p </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="simple_seq_fit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="operator_idp63103520.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="simple_seq_fit.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="operator_idp55988112.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/open_copy_on_write.html b/doc/html/boost/interprocess/open_copy_on_write.html index 68b332a134..5dafd6a56a 100644 --- a/doc/html/boost/interprocess/open_copy_on_write.html +++ b/doc/html/boost/interprocess/open_copy_on_write.html @@ -34,7 +34,7 @@ </span><span class="keyword">static</span> <span class="keyword">const</span> <a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a> open_copy_on_write<span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254720256"></a><h2>Description</h2> +<a name="idp273570848"></a><h2>Description</h2> <p>Value to indicate that the resource must be only opened for reading </p> </div> </div> diff --git a/doc/html/boost/interprocess/open_copy_on_write_t.html b/doc/html/boost/interprocess/open_copy_on_write_t.html index f00eeece9f..13d7b60e8c 100644 --- a/doc/html/boost/interprocess/open_copy_on_write_t.html +++ b/doc/html/boost/interprocess/open_copy_on_write_t.html @@ -36,7 +36,7 @@ <span class="keyword">struct</span> <a class="link" href="open_copy_on_write_t.html" title="Struct open_copy_on_write_t">open_copy_on_write_t</a> <span class="special">{</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254675744"></a><h2>Description</h2> +<a name="idp273526272"></a><h2>Description</h2> <p>Tag to indicate that the resource must be only opened for reading </p> </div> </div> diff --git a/doc/html/boost/interprocess/open_only.html b/doc/html/boost/interprocess/open_only.html index ed1115712e..0a570c277b 100644 --- a/doc/html/boost/interprocess/open_only.html +++ b/doc/html/boost/interprocess/open_only.html @@ -34,7 +34,7 @@ </span><span class="keyword">static</span> <span class="keyword">const</span> <a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> open_only<span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254698256"></a><h2>Description</h2> +<a name="idp273548912"></a><h2>Description</h2> <p>Value to indicate that the resource must be only opened </p> </div> </div> diff --git a/doc/html/boost/interprocess/open_only_t.html b/doc/html/boost/interprocess/open_only_t.html index 1412a2d9a8..d630589ed8 100644 --- a/doc/html/boost/interprocess/open_only_t.html +++ b/doc/html/boost/interprocess/open_only_t.html @@ -36,7 +36,7 @@ <span class="keyword">struct</span> <a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a> <span class="special">{</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254651952"></a><h2>Description</h2> +<a name="idp273502496"></a><h2>Description</h2> <p>Tag to indicate that the resource must be only opened </p> </div> </div> diff --git a/doc/html/boost/interprocess/open_or_create.html b/doc/html/boost/interprocess/open_or_create.html index 2a6bb5477a..56610c270c 100644 --- a/doc/html/boost/interprocess/open_or_create.html +++ b/doc/html/boost/interprocess/open_or_create.html @@ -34,7 +34,7 @@ </span><span class="keyword">static</span> <span class="keyword">const</span> <a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> open_or_create<span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254712912"></a><h2>Description</h2> +<a name="idp273563504"></a><h2>Description</h2> <p>Value to indicate that the resource must be created. If already created, it must be opened. </p> </div> </div> diff --git a/doc/html/boost/interprocess/open_or_create_t.html b/doc/html/boost/interprocess/open_or_create_t.html index 68303a541d..89e050683c 100644 --- a/doc/html/boost/interprocess/open_or_create_t.html +++ b/doc/html/boost/interprocess/open_or_create_t.html @@ -36,7 +36,7 @@ <span class="keyword">struct</span> <a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a> <span class="special">{</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254683632"></a><h2>Description</h2> +<a name="idp273534160"></a><h2>Description</h2> <p>Tag to indicate that the resource must be created. If already created, it must be opened. </p> </div> </div> diff --git a/doc/html/boost/interprocess/open_read_only.html b/doc/html/boost/interprocess/open_read_only.html index b6c54d4412..3221e4d956 100644 --- a/doc/html/boost/interprocess/open_read_only.html +++ b/doc/html/boost/interprocess/open_read_only.html @@ -34,7 +34,7 @@ </span><span class="keyword">static</span> <span class="keyword">const</span> <a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a> open_read_only<span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254705616"></a><h2>Description</h2> +<a name="idp273556208"></a><h2>Description</h2> <p>Value to indicate that the resource must be only opened for reading </p> </div> </div> diff --git a/doc/html/boost/interprocess/open_read_only_t.html b/doc/html/boost/interprocess/open_read_only_t.html index 4e90849f11..ed649ee662 100644 --- a/doc/html/boost/interprocess/open_read_only_t.html +++ b/doc/html/boost/interprocess/open_read_only_t.html @@ -36,7 +36,7 @@ <span class="keyword">struct</span> <a class="link" href="open_read_only_t.html" title="Struct open_read_only_t">open_read_only_t</a> <span class="special">{</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254659824"></a><h2>Description</h2> +<a name="idp273510432"></a><h2>Description</h2> <p>Tag to indicate that the resource must be only opened for reading </p> </div> </div> diff --git a/doc/html/boost/interprocess/open_read_private_t.html b/doc/html/boost/interprocess/open_read_private_t.html index 958a82da62..8ae8fa5b0d 100644 --- a/doc/html/boost/interprocess/open_read_private_t.html +++ b/doc/html/boost/interprocess/open_read_private_t.html @@ -36,7 +36,7 @@ <span class="keyword">struct</span> <a class="link" href="open_read_private_t.html" title="Struct open_read_private_t">open_read_private_t</a> <span class="special">{</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254667744"></a><h2>Description</h2> +<a name="idp273518336"></a><h2>Description</h2> <p>Tag to indicate that the resource must be only opened privately for reading </p> </div> </div> diff --git a/doc/html/boost/interprocess/operator___idp61627680.html b/doc/html/boost/interprocess/operator___idp54512464.html index 8fdeaaa76e..c8c8cc7010 100644 --- a/doc/html/boost/interprocess/operator___idp61627680.html +++ b/doc/html/boost/interprocess/operator___idp54512464.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_hpp" title="Header <boost/interprocess/allocators/adaptive_pool.hpp>"> <link rel="prev" href="adaptive_pool/rebind.html" title="Struct template rebind"> -<link rel="next" href="operator___idp61635952.html" title="Function template operator!="> +<link rel="next" href="operator___idp54520736.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_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="operator___idp61635952.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_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="operator___idp54520736.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp61627680"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp54512464"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -38,7 +38,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp250747584"></a><h2>Description</h2> +<a name="idp269597984"></a><h2>Description</h2> <p>Equality test for same type of <code class="computeroutput"><a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a></code> </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_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="operator___idp61635952.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_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="operator___idp54520736.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp61635952.html b/doc/html/boost/interprocess/operator___idp54520736.html index 9de39261fd..9a067c8b90 100644 --- a/doc/html/boost/interprocess/operator___idp61635952.html +++ b/doc/html/boost/interprocess/operator___idp54520736.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_hpp" title="Header <boost/interprocess/allocators/adaptive_pool.hpp>"> -<link rel="prev" href="operator___idp61627680.html" title="Function template operator=="> +<link rel="prev" href="operator___idp54512464.html" title="Function template operator=="> <link rel="next" href="allocator.html" title="Class template allocator"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61627680.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54512464.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp61635952"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp54520736"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -38,7 +38,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp250786048"></a><h2>Description</h2> +<a name="idp269636448"></a><h2>Description</h2> <p>Inequality test for same type of <code class="computeroutput"><a class="link" href="adaptive_pool.html" title="Class template adaptive_pool">adaptive_pool</a></code> </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61627680.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54512464.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.adaptive_pool_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp61716400.html b/doc/html/boost/interprocess/operator___idp54600992.html index 78a661ea8f..fbffc7e98d 100644 --- a/doc/html/boost/interprocess/operator___idp61716400.html +++ b/doc/html/boost/interprocess/operator___idp54600992.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp" title="Header <boost/interprocess/allocators/allocator.hpp>"> <link rel="prev" href="allocator/rebind.html" title="Struct template rebind"> -<link rel="next" href="operator___idp61721376.html" title="Function template operator!="> +<link rel="next" href="operator___idp54605968.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="operator___idp61721376.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="operator___idp54605968.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp61716400"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp54600992"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp251275264"></a><h2>Description</h2> +<a name="idp270126480"></a><h2>Description</h2> <p>Equality test for same type of allocator </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="operator___idp61721376.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="operator___idp54605968.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp61721376.html b/doc/html/boost/interprocess/operator___idp54605968.html index 632d7e1cfd..f1802be5bf 100644 --- a/doc/html/boost/interprocess/operator___idp61721376.html +++ b/doc/html/boost/interprocess/operator___idp54605968.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp" title="Header <boost/interprocess/allocators/allocator.hpp>"> -<link rel="prev" href="operator___idp61716400.html" title="Function template operator=="> +<link rel="prev" href="operator___idp54600992.html" title="Function template operator=="> <link rel="next" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61716400.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cached_adaptive_pool.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54600992.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cached_adaptive_pool.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp61721376"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp54605968"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">SegmentManager</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp251298640"></a><h2>Description</h2> +<a name="idp270149792"></a><h2>Description</h2> <p>Inequality test for same type of allocator </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61716400.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cached_adaptive_pool.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54600992.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.allocator_hpp"><img src="../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../index.html"><img src="../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="cached_adaptive_pool.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp61823344.html b/doc/html/boost/interprocess/operator___idp54707936.html index 6d5eaa8cce..9daecbdb1a 100644 --- a/doc/html/boost/interprocess/operator___idp61823344.html +++ b/doc/html/boost/interprocess/operator___idp54707936.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_hpp" title="Header <boost/interprocess/allocators/cached_adaptive_pool.hpp>"> <link rel="prev" href="cached_adaptive_pool/rebind.html" title="Struct template rebind"> -<link rel="next" href="operator___idp61831632.html" title="Function template operator!="> +<link rel="next" href="operator___idp54716224.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="cached_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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="operator___idp61831632.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="cached_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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="operator___idp54716224.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp61823344"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp54707936"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -38,7 +38,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp251947408"></a><h2>Description</h2> +<a name="idp270798272"></a><h2>Description</h2> <p>Equality test for same type of <code class="computeroutput"><a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a></code> </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="cached_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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="operator___idp61831632.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="cached_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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="operator___idp54716224.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp61831632.html b/doc/html/boost/interprocess/operator___idp54716224.html index 1500956229..58bccd2a4c 100644 --- a/doc/html/boost/interprocess/operator___idp61831632.html +++ b/doc/html/boost/interprocess/operator___idp54716224.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_hpp" title="Header <boost/interprocess/allocators/cached_adaptive_pool.hpp>"> -<link rel="prev" href="operator___idp61823344.html" title="Function template operator=="> +<link rel="prev" href="operator___idp54707936.html" title="Function template operator=="> <link rel="next" href="cached_node_allocator.html" title="Class template cached_node_allocator"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61823344.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54707936.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp61831632"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp54716224"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -38,7 +38,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp251986336"></a><h2>Description</h2> +<a name="idp270837040"></a><h2>Description</h2> <p>Inequality test for same type of <code class="computeroutput"><a class="link" href="cached_adaptive_pool.html" title="Class template cached_adaptive_pool">cached_adaptive_pool</a></code> </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61823344.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54707936.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.cached_adaptive_pool_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.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp61930576.html b/doc/html/boost/interprocess/operator___idp54815168.html index f86a0fba42..3e75835e48 100644 --- a/doc/html/boost/interprocess/operator___idp61930576.html +++ b/doc/html/boost/interprocess/operator___idp54815168.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <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>"> <link rel="prev" href="cached_node_allocator/rebind.html" title="Struct template rebind"> -<link rel="next" href="operator___idp61937136.html" title="Function template operator!="> +<link rel="next" href="operator___idp54821728.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="cached_node_allocator/rebind.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="operator___idp61937136.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="cached_node_allocator/rebind.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="operator___idp54821728.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp61930576"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp54815168"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <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">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NPC</span> <span class="special">></span> <span class="special">&</span> alloc1<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">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NPC</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp252569168"></a><h2>Description</h2> +<a name="idp271419968"></a><h2>Description</h2> <p>Equality test for same type of <code class="computeroutput"><a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a></code> </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="cached_node_allocator/rebind.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="operator___idp61937136.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="cached_node_allocator/rebind.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="operator___idp54821728.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp61937136.html b/doc/html/boost/interprocess/operator___idp54821728.html index a9d8e3ce7a..5b18052803 100644 --- a/doc/html/boost/interprocess/operator___idp61937136.html +++ b/doc/html/boost/interprocess/operator___idp54821728.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <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>"> -<link rel="prev" href="operator___idp61930576.html" title="Function template operator=="> +<link rel="prev" href="operator___idp54815168.html" title="Function template operator=="> <link rel="next" href="node_allocator.html" title="Class template node_allocator"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61930576.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="node_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54815168.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="node_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp61937136"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp54821728"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <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">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NPC</span> <span class="special">></span> <span class="special">&</span> alloc1<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">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NPC</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp252598608"></a><h2>Description</h2> +<a name="idp271449392"></a><h2>Description</h2> <p>Inequality test for same type of <code class="computeroutput"><a class="link" href="cached_node_allocator.html" title="Class template cached_node_allocator">cached_node_allocator</a></code> </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp61930576.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="node_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54815168.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="node_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp62030496.html b/doc/html/boost/interprocess/operator___idp54915088.html index b660e6b2d2..ef6aa0e62e 100644 --- a/doc/html/boost/interprocess/operator___idp62030496.html +++ b/doc/html/boost/interprocess/operator___idp54915088.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.node_allocator_hpp" title="Header <boost/interprocess/allocators/node_allocator.hpp>"> <link rel="prev" href="node_allocator/rebind.html" title="Struct template rebind"> -<link rel="next" href="operator___idp62037040.html" title="Function template operator!="> +<link rel="next" href="operator___idp54921632.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="node_allocator/rebind.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="operator___idp62037040.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="node_allocator/rebind.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="operator___idp54921632.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp62030496"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp54915088"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NPC</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NPC</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp253155472"></a><h2>Description</h2> +<a name="idp272005984"></a><h2>Description</h2> <p>Equality test for same type of <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code> </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="node_allocator/rebind.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="operator___idp62037040.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="node_allocator/rebind.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="operator___idp54921632.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp62037040.html b/doc/html/boost/interprocess/operator___idp54921632.html index 9bb80a0f37..d93f245481 100644 --- a/doc/html/boost/interprocess/operator___idp62037040.html +++ b/doc/html/boost/interprocess/operator___idp54921632.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.node_allocator_hpp" title="Header <boost/interprocess/allocators/node_allocator.hpp>"> -<link rel="prev" href="operator___idp62030496.html" title="Function template operator=="> +<link rel="prev" href="operator___idp54915088.html" title="Function template operator=="> <link rel="next" href="private_adaptive_pool.html" title="Class template private_adaptive_pool"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62030496.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="private_adaptive_pool.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54915088.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="private_adaptive_pool.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp62037040"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp54921632"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NPC</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NPC</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp253184704"></a><h2>Description</h2> +<a name="idp272035280"></a><h2>Description</h2> <p>Inequality test for same type of <code class="computeroutput"><a class="link" href="node_allocator.html" title="Class template node_allocator">node_allocator</a></code> </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62030496.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="private_adaptive_pool.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54915088.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="private_adaptive_pool.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp62136448.html b/doc/html/boost/interprocess/operator___idp55021040.html index c62a8aac9e..6bc7bd7035 100644 --- a/doc/html/boost/interprocess/operator___idp62136448.html +++ b/doc/html/boost/interprocess/operator___idp55021040.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_hpp" title="Header <boost/interprocess/allocators/private_adaptive_pool.hpp>"> <link rel="prev" href="private_adaptive_pool/rebind.html" title="Struct template rebind"> -<link rel="next" href="operator___idp62144736.html" title="Function template operator!="> +<link rel="next" href="operator___idp55029328.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="operator___idp62144736.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="operator___idp55029328.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp62136448"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp55021040"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -38,7 +38,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp253815568"></a><h2>Description</h2> +<a name="idp272666240"></a><h2>Description</h2> <p>Equality test for same type of <code class="computeroutput"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a></code> </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="operator___idp62144736.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="operator___idp55029328.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp62144736.html b/doc/html/boost/interprocess/operator___idp55029328.html index 7d5a8e5ada..487d5a506f 100644 --- a/doc/html/boost/interprocess/operator___idp62144736.html +++ b/doc/html/boost/interprocess/operator___idp55029328.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_hpp" title="Header <boost/interprocess/allocators/private_adaptive_pool.hpp>"> -<link rel="prev" href="operator___idp62136448.html" title="Function template operator=="> +<link rel="prev" href="operator___idp55021040.html" title="Function template operator=="> <link rel="next" href="private_node_allocator.html" title="Class template private_node_allocator"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62136448.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="private_node_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp55021040.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="private_node_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp62144736"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp55029328"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -38,7 +38,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp253854224"></a><h2>Description</h2> +<a name="idp272704896"></a><h2>Description</h2> <p>Inequality test for same type of <code class="computeroutput"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a></code> </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62136448.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="private_node_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp55021040.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="private_node_allocator.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp62241568.html b/doc/html/boost/interprocess/operator___idp55126160.html index e3dc11d355..0001e2bf87 100644 --- a/doc/html/boost/interprocess/operator___idp62241568.html +++ b/doc/html/boost/interprocess/operator___idp55126160.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_node_allocator_hpp" title="Header <boost/interprocess/allocators/private_node_allocator.hpp>"> <link rel="prev" href="private_node_allocator/rebind.html" title="Struct template rebind"> -<link rel="next" href="operator___idp62249856.html" title="Function template operator!="> +<link rel="next" href="operator___idp55134448.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="private_node_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="operator___idp62249856.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="private_node_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="operator___idp55134448.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp62241568"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp55126160"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -38,7 +38,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254454256"></a><h2>Description</h2> +<a name="idp273304528"></a><h2>Description</h2> <p>Equality test for same type of <code class="computeroutput"><a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a></code> </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="private_node_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="operator___idp62249856.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="private_node_allocator/rebind.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="operator___idp55134448.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp62249856.html b/doc/html/boost/interprocess/operator___idp55134448.html index 66f8b2bab5..62de3a4df4 100644 --- a/doc/html/boost/interprocess/operator___idp62249856.html +++ b/doc/html/boost/interprocess/operator___idp55134448.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_node_allocator_hpp" title="Header <boost/interprocess/allocators/private_node_allocator.hpp>"> -<link rel="prev" href="operator___idp62241568.html" title="Function template operator=="> +<link rel="prev" href="operator___idp55126160.html" title="Function template operator=="> <link rel="next" href="anonymous_shared_memory.html" title="Function anonymous_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62241568.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="anonymous_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp55126160.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="anonymous_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp62249856"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp55134448"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -38,7 +38,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">S</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span><span class="special">,</span> <span class="identifier">F</span><span class="special">,</span> <span class="identifier">OP</span> <span class="special">></span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254492992"></a><h2>Description</h2> +<a name="idp273343136"></a><h2>Description</h2> <p>Inequality test for same type of <code class="computeroutput"><a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a></code> </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62241568.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="anonymous_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp55126160.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="anonymous_shared_memory.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp63401200.html b/doc/html/boost/interprocess/operator___idp56285792.html index c867557678..0621e9cb0d 100644 --- a/doc/html/boost/interprocess/operator___idp63401200.html +++ b/doc/html/boost/interprocess/operator___idp56285792.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> <link rel="prev" href="intrusive_ptr.html" title="Class template intrusive_ptr"> -<link rel="next" href="operator___idp63406416.html" title="Function template operator!="> +<link rel="next" href="operator___idp56291008.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="intrusive_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63406416.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="intrusive_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56291008.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp63401200"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp56285792"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> a<span class="special">,</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261125760"></a><h2>Description</h2> +<a name="idp279976752"></a><h2>Description</h2> <p>Returns a.get() == b.get(). Does not throw </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="intrusive_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63406416.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="intrusive_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56291008.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp63406416.html b/doc/html/boost/interprocess/operator___idp56291008.html index 1ee7224da8..0be5722180 100644 --- a/doc/html/boost/interprocess/operator___idp63406416.html +++ b/doc/html/boost/interprocess/operator___idp56291008.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> -<link rel="prev" href="operator___idp63401200.html" title="Function template operator=="> -<link rel="next" href="operator___idp63411632.html" title="Function template operator=="> +<link rel="prev" href="operator___idp56285792.html" title="Function template operator=="> +<link rel="next" href="operator___idp56296224.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63401200.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63411632.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56285792.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56296224.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp63406416"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp56291008"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> a<span class="special">,</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">U</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261150320"></a><h2>Description</h2> +<a name="idp280001312"></a><h2>Description</h2> <p>Returns a.get() != b.get(). Does not throw </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63401200.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63411632.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56285792.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56296224.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp63411632.html b/doc/html/boost/interprocess/operator___idp56296224.html index dfa3b93637..7d1452bcd7 100644 --- a/doc/html/boost/interprocess/operator___idp63411632.html +++ b/doc/html/boost/interprocess/operator___idp56296224.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> -<link rel="prev" href="operator___idp63406416.html" title="Function template operator!="> -<link rel="next" href="operator___idp63416432.html" title="Function template operator!="> +<link rel="prev" href="operator___idp56291008.html" title="Function template operator!="> +<link rel="next" href="operator___idp56301024.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63406416.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63416432.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56291008.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56301024.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp63411632"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp56296224"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> a<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">typename</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span><span class="special">::</span><span class="identifier">pointer</span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261175248"></a><h2>Description</h2> +<a name="idp280026208"></a><h2>Description</h2> <p>Returns a.get() == b. Does not throw </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63406416.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63416432.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56291008.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56301024.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp63416432.html b/doc/html/boost/interprocess/operator___idp56301024.html index ea791d3327..a175c22e2f 100644 --- a/doc/html/boost/interprocess/operator___idp63416432.html +++ b/doc/html/boost/interprocess/operator___idp56301024.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> -<link rel="prev" href="operator___idp63411632.html" title="Function template operator=="> -<link rel="next" href="operator___idp63421232.html" title="Function template operator=="> +<link rel="prev" href="operator___idp56296224.html" title="Function template operator=="> +<link rel="next" href="operator___idp56305824.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63411632.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63421232.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56296224.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56305824.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp63416432"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp56301024"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> a<span class="special">,</span> <span class="keyword">const</span> <span class="keyword">typename</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span><span class="special">::</span><span class="identifier">pointer</span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261200160"></a><h2>Description</h2> +<a name="idp280051168"></a><h2>Description</h2> <p>Returns a.get() != b. Does not throw </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63411632.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63421232.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56296224.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56305824.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp63421232.html b/doc/html/boost/interprocess/operator___idp56305824.html index 32ad0fecde..7dd7154472 100644 --- a/doc/html/boost/interprocess/operator___idp63421232.html +++ b/doc/html/boost/interprocess/operator___idp56305824.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> -<link rel="prev" href="operator___idp63416432.html" title="Function template operator!="> -<link rel="next" href="operator___idp63426032.html" title="Function template operator!="> +<link rel="prev" href="operator___idp56301024.html" title="Function template operator!="> +<link rel="next" href="operator___idp56310624.html" title="Function template operator!="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63416432.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63426032.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56301024.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56310624.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator==_idp63421232"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator==_idp56305824"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator==</span></h2> <p>boost::interprocess::operator==</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">==</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">typename</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span><span class="special">::</span><span class="identifier">pointer</span> <span class="special">&</span> a<span class="special">,</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261225072"></a><h2>Description</h2> +<a name="idp280076080"></a><h2>Description</h2> <p>Returns a == b.get(). Does not throw </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63416432.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp63426032.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56301024.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator___idp56310624.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator___idp63426032.html b/doc/html/boost/interprocess/operator___idp56310624.html index 763334ada7..c8b897457a 100644 --- a/doc/html/boost/interprocess/operator___idp63426032.html +++ b/doc/html/boost/interprocess/operator___idp56310624.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> -<link rel="prev" href="operator___idp63421232.html" title="Function template operator=="> -<link rel="next" href="operator_idp63430832.html" title="Function template operator<"> +<link rel="prev" href="operator___idp56305824.html" title="Function template operator=="> +<link rel="next" href="operator_idp56315424.html" title="Function template operator<"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63421232.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator_idp63430832.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56305824.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator_idp56315424.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator!=_idp63426032"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator!=_idp56310624"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator!=</span></h2> <p>boost::interprocess::operator!=</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special">!=</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">typename</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span><span class="special">::</span><span class="identifier">pointer</span> <span class="special">&</span> a<span class="special">,</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261250048"></a><h2>Description</h2> +<a name="idp280101056"></a><h2>Description</h2> <p>Returns a != b.get(). Does not throw </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63421232.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator_idp63430832.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56305824.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="operator_idp56315424.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator_idp63103520.html b/doc/html/boost/interprocess/operator_idp55988112.html index 85876c1c85..b4e37af3d9 100644 --- a/doc/html/boost/interprocess/operator_idp63103520.html +++ b/doc/html/boost/interprocess/operator_idp55988112.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_hpp" title="Header <boost/interprocess/offset_ptr.hpp>"> <link rel="prev" href="offset_ptr.html" title="Class template offset_ptr"> -<link rel="next" href="operator_idp63110432.html" title="Function template operator>>"> +<link rel="next" href="operator_idp55995024.html" title="Function template operator>>"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="offset_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="operator_idp63110432.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="offset_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="operator_idp55995024.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator_idp63103520"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator_idp55988112"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator<<</span></h2> <p>boost::interprocess::operator<<</p> @@ -39,7 +39,7 @@ <span class="keyword">operator</span><span class="special"><<</span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_ostream</span><span class="special"><</span> <span class="identifier">E</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> os<span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">W</span><span class="special">,</span> <span class="identifier">X</span><span class="special">,</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">Z</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp259313936"></a><h2>Description</h2> +<a name="idp278164512"></a><h2>Description</h2> <p>operator<< for offset ptr </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="offset_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="operator_idp63110432.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="offset_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="operator_idp55995024.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator_idp63110432.html b/doc/html/boost/interprocess/operator_idp55995024.html index 4e96e1064c..cfdb92d79f 100644 --- a/doc/html/boost/interprocess/operator_idp63110432.html +++ b/doc/html/boost/interprocess/operator_idp55995024.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_hpp" title="Header <boost/interprocess/offset_ptr.hpp>"> -<link rel="prev" href="operator_idp63103520.html" title="Function template operator<<"> +<link rel="prev" href="operator_idp55988112.html" title="Function template operator<<"> <link rel="next" href="permissions.html" title="Class permissions"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator_idp63103520.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="permissions.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator_idp55988112.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="permissions.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator_idp63110432"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator_idp55995024"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator>></span></h2> <p>boost::interprocess::operator>></p> @@ -38,7 +38,7 @@ <span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">E</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> <span class="keyword">operator</span><span class="special">>></span><span class="special">(</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">basic_istream</span><span class="special"><</span> <span class="identifier">E</span><span class="special">,</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&</span> is<span class="special">,</span> <a class="link" href="offset_ptr.html" title="Class template offset_ptr">offset_ptr</a><span class="special"><</span> <span class="identifier">W</span><span class="special">,</span> <span class="identifier">X</span><span class="special">,</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">Z</span> <span class="special">></span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp259350416"></a><h2>Description</h2> +<a name="idp278200944"></a><h2>Description</h2> <p>operator>> for offset ptr </p> </div> </div> @@ -52,7 +52,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator_idp63103520.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="permissions.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator_idp55988112.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.offset_ptr_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="permissions.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/operator_idp63430832.html b/doc/html/boost/interprocess/operator_idp56315424.html index 311d1339fa..958909f2f7 100644 --- a/doc/html/boost/interprocess/operator_idp63430832.html +++ b/doc/html/boost/interprocess/operator_idp56315424.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> -<link rel="prev" href="operator___idp63426032.html" title="Function template operator!="> -<link rel="next" href="swap_idp63435488.html" title="Function template swap"> +<link rel="prev" href="operator___idp56310624.html" title="Function template operator!="> +<link rel="next" href="swap_idp56320080.html" title="Function template swap"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63426032.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="swap_idp63435488.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56310624.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="swap_idp56320080.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.operator_idp63430832"></a><div class="titlepage"></div> +<a name="boost.interprocess.operator_idp56315424"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template operator<</span></h2> <p>boost::interprocess::operator<</p> @@ -37,7 +37,7 @@ <span class="keyword">bool</span> <span class="keyword">operator</span><span class="special"><</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> a<span class="special">,</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261273296"></a><h2>Description</h2> +<a name="idp280124240"></a><h2>Description</h2> <p>Returns a.get() < b.get(). Does not throw </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp63426032.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="swap_idp63435488.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp56310624.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="swap_idp56320080.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/permissions.html b/doc/html/boost/interprocess/permissions.html index 4d6fde6ff4..b4ad7b7c1c 100644 --- a/doc/html/boost/interprocess/permissions.html +++ b/doc/html/boost/interprocess/permissions.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.permissions_hpp" title="Header <boost/interprocess/permissions.hpp>"> -<link rel="prev" href="operator_idp63110432.html" title="Function template operator>>"> +<link rel="prev" href="operator_idp55995024.html" title="Function template operator>>"> <link rel="next" href="segment_manager_base.html" title="Class template segment_manager_base"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator_idp63110432.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.permissions_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="segment_manager_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator_idp55995024.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.permissions_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="segment_manager_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.permissions"></a><div class="titlepage"></div> @@ -36,52 +36,52 @@ <span class="keyword">class</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="permissions.html#boost.interprocess.permissionsconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="permissions.html#idp63159792-bb"><span class="identifier">permissions</span></a><span class="special">(</span><span class="identifier">os_permissions_type</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="permissions.html#idp63161248-bb"><span class="identifier">permissions</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="permissions.html#idp56044384-bb"><span class="identifier">permissions</span></a><span class="special">(</span><span class="identifier">os_permissions_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="permissions.html#idp56045840-bb"><span class="identifier">permissions</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="permissions.html#idp63152832-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="permissions.html#idp63153392-bb"><span class="identifier">set_default</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="permissions.html#idp63154736-bb"><span class="identifier">set_unrestricted</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="permissions.html#idp63156064-bb"><span class="identifier">set_permissions</span></a><span class="special">(</span><span class="identifier">os_permissions_type</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">os_permissions_type</span> <a class="link" href="permissions.html#idp63158064-bb"><span class="identifier">get_permissions</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="permissions.html#idp56037424-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="permissions.html#idp56037984-bb"><span class="identifier">set_default</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="permissions.html#idp56039328-bb"><span class="identifier">set_unrestricted</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="permissions.html#idp56040656-bb"><span class="identifier">set_permissions</span></a><span class="special">(</span><span class="identifier">os_permissions_type</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">os_permissions_type</span> <a class="link" href="permissions.html#idp56042656-bb"><span class="identifier">get_permissions</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp259394784"></a><h2>Description</h2> +<a name="idp278245200"></a><h2>Description</h2> <p>The permissions class represents permissions to be set to shared memory or files, that can be constructed form usual permission representations: a SECURITY_ATTRIBUTES pointer in windows or ORed rwx chmod integer in UNIX. </p> <div class="refsect2"> -<a name="idp259395696"></a><h3> +<a name="idp278246112"></a><h3> <a name="boost.interprocess.permissionsconstruct-copy-destruct"></a><code class="computeroutput">permissions</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63159792-bb"></a><span class="identifier">permissions</span><span class="special">(</span><span class="identifier">os_permissions_type</span> type<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56044384-bb"></a><span class="identifier">permissions</span><span class="special">(</span><span class="identifier">os_permissions_type</span> type<span class="special">)</span><span class="special">;</span></pre> <p>Constructs a permissions object from a user provided os-dependent permissions. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63161248-bb"></a><span class="identifier">permissions</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56045840-bb"></a><span class="identifier">permissions</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs a default permissions object: A null security attributes pointer for windows or 0644 for UNIX. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp259406528"></a><h3> -<a name="idp63152832-bb"></a><code class="computeroutput">permissions</code> public member functions</h3> +<a name="idp278256944"></a><h3> +<a name="idp56037424-bb"></a><code class="computeroutput">permissions</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63153392-bb"></a><span class="identifier">set_default</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56037984-bb"></a><span class="identifier">set_default</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Sets permissions to default values: A null security attributes pointer for windows or 0644 for UNIX. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63154736-bb"></a><span class="identifier">set_unrestricted</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56039328-bb"></a><span class="identifier">set_unrestricted</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Sets permissions to unrestricted access: A null DACL for windows or 0666 for UNIX. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63156064-bb"></a><span class="identifier">set_permissions</span><span class="special">(</span><span class="identifier">os_permissions_type</span> perm<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56040656-bb"></a><span class="identifier">set_permissions</span><span class="special">(</span><span class="identifier">os_permissions_type</span> perm<span class="special">)</span><span class="special">;</span></pre> <p>Sets permissions from a user provided os-dependent permissions. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">os_permissions_type</span> <a name="idp63158064-bb"></a><span class="identifier">get_permissions</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">os_permissions_type</span> <a name="idp56042656-bb"></a><span class="identifier">get_permissions</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns stored os-dependent permissions </p> </li> </ol></div> @@ -98,7 +98,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator_idp63110432.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.permissions_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="segment_manager_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator_idp55995024.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.permissions_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="segment_manager_base.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/private_adaptive_pool.html b/doc/html/boost/interprocess/private_adaptive_pool.html index fe4653701a..5172e82459 100644 --- a/doc/html/boost/interprocess/private_adaptive_pool.html +++ b/doc/html/boost/interprocess/private_adaptive_pool.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_hpp" title="Header <boost/interprocess/allocators/private_adaptive_pool.hpp>"> -<link rel="prev" href="operator___idp62037040.html" title="Function template operator!="> +<link rel="prev" href="operator___idp54921632.html" title="Function template operator!="> <link rel="next" href="private_adaptive_pool/rebind.html" title="Struct template rebind"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62037040.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54921632.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.private_adaptive_pool"></a><div class="titlepage"></div> @@ -55,173 +55,173 @@ <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="private_adaptive_pool.html#boost.interprocess.private_adaptive_poolconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="private_adaptive_pool.html#idp62122752-bb"><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="private_adaptive_pool.html#idp62125024-bb"><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_adaptive_pool.html#idp55007344-bb"><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_adaptive_pool.html#idp55009616-bb"><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="private_adaptive_pool.html#idp62127696-bb"><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_adaptive_pool.html#idp55012288-bb"><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</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> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> F2<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> OP2<span class="special">></span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span> - <a class="link" href="private_adaptive_pool.html#idp62065248-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="identifier">F2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span> <a class="link" href="private_adaptive_pool.html#idp62072400-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="private_adaptive_pool.html#idp62132048-bb"><span class="special">~</span><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_adaptive_pool.html#idp54949840-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="identifier">F2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span> <a class="link" href="private_adaptive_pool.html#idp54956992-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_adaptive_pool.html#idp55016640-bb"><span class="special">~</span><span class="identifier">private_adaptive_pool</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="private_adaptive_pool.html#idp62075584-bb">public member functions</a></span> - <span class="identifier">node_pool_t</span> <span class="special">*</span> <a class="link" href="private_adaptive_pool.html#idp62076144-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="private_adaptive_pool.html#idp62077712-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="private_adaptive_pool.html#idp62079280-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="private_adaptive_pool.html#idp62080864-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="private_adaptive_pool.html#idp62084592-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="private_adaptive_pool.html#idp62087264-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="private_adaptive_pool.html#idp62088560-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="private_adaptive_pool.html#idp62090816-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="private_adaptive_pool.html#idp62093072-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="private_adaptive_pool.html#idp62095760-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="private_adaptive_pool.html#idp62097744-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">pointer</span> <a class="link" href="private_adaptive_pool.html#idp62100144-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="comment">// <a class="link" href="private_adaptive_pool.html#idp54960176-bb">public member functions</a></span> + <span class="identifier">node_pool_t</span> <span class="special">*</span> <a class="link" href="private_adaptive_pool.html#idp54960736-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="private_adaptive_pool.html#idp54962304-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="private_adaptive_pool.html#idp54963872-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="private_adaptive_pool.html#idp54965456-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="private_adaptive_pool.html#idp54969184-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="private_adaptive_pool.html#idp54971856-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="private_adaptive_pool.html#idp54973152-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="private_adaptive_pool.html#idp54975408-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="private_adaptive_pool.html#idp54977664-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="private_adaptive_pool.html#idp54980352-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="private_adaptive_pool.html#idp54982336-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">pointer</span> <a class="link" href="private_adaptive_pool.html#idp54984736-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="special">,</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="private_adaptive_pool.html#idp62103776-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> - <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp62107408-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> - <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp62110848-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> - <span class="identifier">pointer</span> <a class="link" href="private_adaptive_pool.html#idp62113104-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp62115232-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">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp62118192-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="private_adaptive_pool.html#idp62120320-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="special">;</span> + <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp54988368-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> + <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp54992000-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> + <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp54995440-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> + <span class="identifier">pointer</span> <a class="link" href="private_adaptive_pool.html#idp54997696-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp54999824-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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp55002784-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="private_adaptive_pool.html#idp55004912-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="special">;</span> - <span class="comment">// <a class="link" href="private_adaptive_pool.html#idp62132832-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp62133392-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="private_adaptive_pool.html#idp55017424-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="private_adaptive_pool.html#idp55017984-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="idp253528336"></a><h2>Description</h2> +<a name="idp272378880"></a><h2>Description</h2> <p>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc... This allocator has its own node pool.</p> <p>NodesPerBlock is the minimum number of nodes of nodes allocated at once when the allocator needs runs out of nodes. MaxFreeBlocks is the maximum number of totally free blocks that the adaptive node pool will hold. The rest of the totally free blocks will be deallocated with the segment manager.</p> <p>OverheadPercent is the (approximated) maximum size overhead (1-20%) of the allocator: (memory usable for nodes / total memory allocated from the segment manager) </p> <div class="refsect2"> -<a name="idp253530304"></a><h3> +<a name="idp272380848"></a><h3> <a name="boost.interprocess.private_adaptive_poolconstruct-copy-destruct"></a><code class="computeroutput">private_adaptive_pool</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62122752-bb"></a><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55007344-bb"></a><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> <p>Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62125024-bb"></a><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55009616-bb"></a><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from other <code class="computeroutput"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a></code>. Increments the reference count of the associated node pool. Never throws </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> - <a name="idp62127696-bb"></a><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> + <a name="idp55012288-bb"></a><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from related <code class="computeroutput"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a></code>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> SegmentManager2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> F2<span class="special">,</span> <span class="keyword">unsigned</span> <span class="keyword">char</span> OP2<span class="special">></span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span> - <a name="idp62065248-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="identifier">F2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp54949840-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="identifier">F2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from related <code class="computeroutput"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span> <a name="idp62072400-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span> <a name="idp54956992-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from other <code class="computeroutput"><a class="link" href="private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62132048-bb"></a><span class="special">~</span><span class="identifier">private_adaptive_pool</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55016640-bb"></a><span class="special">~</span><span class="identifier">private_adaptive_pool</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="idp253604352"></a><h3> -<a name="idp62075584-bb"></a><code class="computeroutput">private_adaptive_pool</code> public member functions</h3> +<a name="idp272454768"></a><h3> +<a name="idp54960176-bb"></a><code class="computeroutput">private_adaptive_pool</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="idp62076144-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">node_pool_t</span> <span class="special">*</span> <a name="idp54960736-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a pointer to the node pool. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp62077712-bb"></a><span class="identifier">get_segment_manager</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp54962304-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="idp62079280-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54963872-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="idp62080864-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54965456-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocate memory for an array of count elements. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62084592-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54969184-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="idp62087264-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54971856-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="idp62088560-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54973152-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="idp62090816-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">const_reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idp54975408-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="idp62093072-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54977664-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> <p>Copy construct an object. Throws if T's copy constructor throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62095760-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54980352-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="idp62097744-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp54982336-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">pointer</span> <a name="idp62100144-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> +<li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54984736-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> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">pointer</span> <span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62103776-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54988368-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">size_type</span> num_elements<span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&</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="keyword">void</span> <a name="idp62107408-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54992000-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<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="idp62110848-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54995440-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> <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="idp62113104-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp54997696-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62115232-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp54999824-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<span class="special">)</span><span class="special">;</span></pre> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62118192-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55002784-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="idp62120320-bb"></a><span class="identifier">deallocate_individual</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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55004912-bb"></a><span class="identifier">deallocate_individual</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> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp253744656"></a><h3> -<a name="idp62132832-bb"></a><code class="computeroutput">private_adaptive_pool</code> friend functions</h3> +<a name="idp272595344"></a><h3> +<a name="idp55017424-bb"></a><code class="computeroutput">private_adaptive_pool</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="idp62133392-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp55017984-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> @@ -237,7 +237,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62037040.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp54921632.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_adaptive_pool_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="private_adaptive_pool/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/private_adaptive_pool/rebind.html b/doc/html/boost/interprocess/private_adaptive_pool/rebind.html index f3f56c18c6..8739134681 100644 --- a/doc/html/boost/interprocess/private_adaptive_pool/rebind.html +++ b/doc/html/boost/interprocess/private_adaptive_pool/rebind.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../private_adaptive_pool.html#idp253528336" title="Description"> +<link rel="up" href="../private_adaptive_pool.html#idp272378880" title="Description"> <link rel="prev" href="../private_adaptive_pool.html" title="Class template private_adaptive_pool"> -<link rel="next" href="../operator___idp62136448.html" title="Function template operator=="> +<link rel="next" href="../operator___idp55021040.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../private_adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../private_adaptive_pool.html#idp253528336"><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="../operator___idp62136448.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../private_adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../private_adaptive_pool.html#idp272378880"><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="../operator___idp55021040.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.private_adaptive_pool.rebind"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <span class="keyword">typedef</span> <a class="link" href="../private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</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="identifier">MaxFreeBlocks</span><span class="special">,</span> <span class="identifier">OverheadPercent</span> <span class="special">></span> <a name="boost.interprocess.private_adaptive_pool.rebind.other"></a><span class="identifier">other</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp253776352"></a><h2>Description</h2> +<a name="idp272627104"></a><h2>Description</h2> <p>Obtains <a class="link" href="../private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> from <a class="link" href="../private_adaptive_pool.html" title="Class template private_adaptive_pool">private_adaptive_pool</a> </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../private_adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../private_adaptive_pool.html#idp253528336"><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="../operator___idp62136448.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../private_adaptive_pool.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../private_adaptive_pool.html#idp272378880"><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="../operator___idp55021040.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/private_node_allocator.html b/doc/html/boost/interprocess/private_node_allocator.html index 96e14ed6b6..a75c6bd547 100644 --- a/doc/html/boost/interprocess/private_node_allocator.html +++ b/doc/html/boost/interprocess/private_node_allocator.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_node_allocator_hpp" title="Header <boost/interprocess/allocators/private_node_allocator.hpp>"> -<link rel="prev" href="operator___idp62144736.html" title="Function template operator!="> +<link rel="prev" href="operator___idp55029328.html" title="Function template operator!="> <link rel="next" href="private_node_allocator/rebind.html" title="Struct template rebind"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62144736.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="private_node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp55029328.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="private_node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.private_node_allocator"></a><div class="titlepage"></div> @@ -54,169 +54,169 @@ <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="private_node_allocator.html#boost.interprocess.private_node_allocatorconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="private_node_allocator.html#idp62227904-bb"><span class="identifier">private_node_allocator</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="private_node_allocator.html#idp62230176-bb"><span class="identifier">private_node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_node_allocator.html#idp55112496-bb"><span class="identifier">private_node_allocator</span></a><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_node_allocator.html#idp55114768-bb"><span class="identifier">private_node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_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="private_node_allocator.html#idp62232848-bb"><span class="identifier">private_node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_node_allocator.html#idp55117440-bb"><span class="identifier">private_node_allocator</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_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> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span> - <a class="link" href="private_node_allocator.html#idp62172096-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span> <a class="link" href="private_node_allocator.html#idp62177552-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="private_node_allocator.html#idp62237168-bb"><span class="special">~</span><span class="identifier">private_node_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_node_allocator.html#idp55056688-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span> <a class="link" href="private_node_allocator.html#idp55062144-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="private_node_allocator.html#idp55121760-bb"><span class="special">~</span><span class="identifier">private_node_allocator</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="private_node_allocator.html#idp62180736-bb">public member functions</a></span> - <span class="identifier">node_pool_t</span> <span class="special">*</span> <a class="link" href="private_node_allocator.html#idp62181296-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="private_node_allocator.html#idp62182864-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="private_node_allocator.html#idp62184432-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="private_node_allocator.html#idp62186016-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="private_node_allocator.html#idp62189744-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="private_node_allocator.html#idp62192416-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="private_node_allocator.html#idp62193712-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="private_node_allocator.html#idp62195968-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="private_node_allocator.html#idp62198224-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="private_node_allocator.html#idp62200912-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="private_node_allocator.html#idp62202896-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">pointer</span> <a class="link" href="private_node_allocator.html#idp62205296-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="comment">// <a class="link" href="private_node_allocator.html#idp55065328-bb">public member functions</a></span> + <span class="identifier">node_pool_t</span> <span class="special">*</span> <a class="link" href="private_node_allocator.html#idp55065888-bb"><span class="identifier">get_node_pool</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">segment_manager</span> <span class="special">*</span> <a class="link" href="private_node_allocator.html#idp55067456-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="private_node_allocator.html#idp55069024-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="private_node_allocator.html#idp55070608-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="private_node_allocator.html#idp55074336-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="private_node_allocator.html#idp55077008-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="private_node_allocator.html#idp55078304-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="private_node_allocator.html#idp55080560-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="private_node_allocator.html#idp55082816-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="private_node_allocator.html#idp55085504-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="private_node_allocator.html#idp55087488-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">pointer</span> <a class="link" href="private_node_allocator.html#idp55089888-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="special">,</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="private_node_allocator.html#idp62208928-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> - <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp62212560-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> - <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp62216000-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> - <span class="identifier">pointer</span> <a class="link" href="private_node_allocator.html#idp62218256-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp62220384-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">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp62223344-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="private_node_allocator.html#idp62225472-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="special">;</span> + <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp55093520-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> + <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp55097152-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> + <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp55100592-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> + <span class="identifier">pointer</span> <a class="link" href="private_node_allocator.html#idp55102848-bb"><span class="identifier">allocate_one</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp55104976-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">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp55107936-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="private_node_allocator.html#idp55110064-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="special">;</span> - <span class="comment">// <a class="link" href="private_node_allocator.html#idp62237952-bb">friend functions</a></span> - <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp62238512-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span><span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="private_node_allocator.html#idp55122544-bb">friend functions</a></span> + <span class="keyword">friend</span> <span class="keyword">void</span> <a class="link" href="private_node_allocator.html#idp55123104-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="idp254178480"></a><h2>Description</h2> +<a name="idp273028816"></a><h2>Description</h2> <p>An STL node allocator that uses a segment manager as memory source. The internal pointer type will of the same type (raw, smart) as "typename SegmentManager::void_pointer" type. This allows placing the allocator in shared memory, memory mapped-files, etc... This allocator has its own node pool. NodesPerBlock is the number of nodes allocated at once when the allocator needs runs out of nodes </p> <div class="refsect2"> -<a name="idp254179568"></a><h3> +<a name="idp273029904"></a><h3> <a name="boost.interprocess.private_node_allocatorconstruct-copy-destruct"></a><code class="computeroutput">private_node_allocator</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62227904-bb"></a><span class="identifier">private_node_allocator</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55112496-bb"></a><span class="identifier">private_node_allocator</span><span class="special">(</span><span class="identifier">segment_manager</span> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> <p>Constructor from a segment manager. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62230176-bb"></a><span class="identifier">private_node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55114768-bb"></a><span class="identifier">private_node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from other <code class="computeroutput"><a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a></code>. Increments the reference count of the associated node pool. Never throws </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">></span> - <a name="idp62232848-bb"></a><span class="identifier">private_node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> + <a name="idp55117440-bb"></a><span class="identifier">private_node_allocator</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager</span><span class="special">,</span> <span class="identifier">NodesPerBlock</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructor from related <code class="computeroutput"><a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a></code>. If not present, constructs a node pool. Increments the reference count of the associated node pool. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T2<span class="special">,</span> <span class="keyword">typename</span> SegmentManager2<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> N2<span class="special">></span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span> - <a name="idp62172096-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_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> + <a name="idp55056688-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a><span class="special"><</span> <span class="identifier">T2</span><span class="special">,</span> <span class="identifier">SegmentManager2</span><span class="special">,</span> <span class="identifier">N2</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from related <code class="computeroutput"><a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span> <a name="idp62177552-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span> <a name="idp55062144-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Not assignable from other <code class="computeroutput"><a class="link" href="private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a></code> </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62237168-bb"></a><span class="special">~</span><span class="identifier">private_node_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55121760-bb"></a><span class="special">~</span><span class="identifier">private_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="idp254245536"></a><h3> -<a name="idp62180736-bb"></a><code class="computeroutput">private_node_allocator</code> public member functions</h3> +<a name="idp273095744"></a><h3> +<a name="idp55065328-bb"></a><code class="computeroutput">private_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="idp62181296-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">node_pool_t</span> <span class="special">*</span> <a name="idp55065888-bb"></a><span class="identifier">get_node_pool</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a pointer to the node pool. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp62182864-bb"></a><span class="identifier">get_segment_manager</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">segment_manager</span> <span class="special">*</span> <a name="idp55067456-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="idp62184432-bb"></a><span class="identifier">max_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55069024-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="idp62186016-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp55070608-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> count<span class="special">,</span> <span class="identifier">cvoid_pointer</span> hint <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocate memory for an array of count elements. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62189744-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">size_type</span> count<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55074336-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="idp62192416-bb"></a><span class="identifier">deallocate_free_blocks</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55077008-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="idp62193712-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp55078304-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="idp62195968-bb"></a><span class="identifier">address</span><span class="special">(</span><span class="identifier">const_reference</span> value<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_pointer</span> <a name="idp55080560-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="idp62198224-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55082816-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">,</span> <span class="identifier">const_reference</span> v<span class="special">)</span><span class="special">;</span></pre> <p>Copy construct an object. Throws if T's copy constructor throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62200912-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55085504-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="idp62202896-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55087488-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">pointer</span> <a name="idp62205296-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> +<li class="listitem"><pre class="literallayout"><span class="identifier">pointer</span> <a name="idp55089888-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> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">pointer</span> <span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62208928-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55093520-bb"></a><span class="identifier">allocate_many</span><span class="special">(</span><span class="identifier">size_type</span> elem_size<span class="special">,</span> <span class="identifier">size_type</span> num_elements<span class="special">,</span> <span class="identifier">multiallocation_chain</span> <span class="special">&</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="keyword">void</span> <a name="idp62212560-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55097152-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<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="idp62216000-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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55100592-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> <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="idp62218256-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp55102848-bb"></a><span class="identifier">allocate_one</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates just one object. Memory allocated with this function must be deallocated only with deallocate_one(). Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62220384-bb"></a><span class="identifier">allocate_individual</span><span class="special">(</span><span class="identifier">size_type</span> num_elements<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55104976-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="identifier">multiallocation_chain</span> <span class="special">&</span> chain<span class="special">)</span><span class="special">;</span></pre> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62223344-bb"></a><span class="identifier">deallocate_one</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55107936-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="idp62225472-bb"></a><span class="identifier">deallocate_individual</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> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55110064-bb"></a><span class="identifier">deallocate_individual</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> <p>Allocates many elements of size == 1 in a contiguous block of memory. The minimum number to be allocated is min_elements, the preferred and maximum number is preferred_elements. The number of actually allocated elements is will be assigned to received_size. Memory allocated with this function must be deallocated only with deallocate_one(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp254385968"></a><h3> -<a name="idp62237952-bb"></a><code class="computeroutput">private_node_allocator</code> friend functions</h3> +<a name="idp273236240"></a><h3> +<a name="idp55122544-bb"></a><code class="computeroutput">private_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="idp62238512-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">self_t</span> <span class="special">&</span> alloc1<span class="special">,</span> <span class="identifier">self_t</span> <span class="special">&</span> alloc2<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">friend</span> <span class="keyword">void</span> <a name="idp55123104-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> @@ -232,7 +232,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator___idp62144736.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="private_node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator___idp55029328.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.allocators.private_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="private_node_allocator/rebind.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/private_node_allocator/rebind.html b/doc/html/boost/interprocess/private_node_allocator/rebind.html index e743761c61..bc8ff91a98 100644 --- a/doc/html/boost/interprocess/private_node_allocator/rebind.html +++ b/doc/html/boost/interprocess/private_node_allocator/rebind.html @@ -6,9 +6,9 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../private_node_allocator.html#idp254178480" title="Description"> +<link rel="up" href="../private_node_allocator.html#idp273028816" title="Description"> <link rel="prev" href="../private_node_allocator.html" title="Class template private_node_allocator"> -<link rel="next" href="../operator___idp62241568.html" title="Function template operator=="> +<link rel="next" href="../operator___idp55126160.html" title="Function template operator=="> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../private_node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../private_node_allocator.html#idp254178480"><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="../operator___idp62241568.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../private_node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../private_node_allocator.html#idp273028816"><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="../operator___idp55126160.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.private_node_allocator.rebind"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <span class="keyword">typedef</span> <a class="link" href="../private_node_allocator.html" title="Class template private_node_allocator">private_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> <a name="boost.interprocess.private_node_allocator.rebind.other"></a><span class="identifier">other</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp254415168"></a><h2>Description</h2> +<a name="idp273265376"></a><h2>Description</h2> <p>Obtains <a class="link" href="../private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> from <a class="link" href="../private_node_allocator.html" title="Class template private_node_allocator">private_node_allocator</a> </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../private_node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../private_node_allocator.html#idp254178480"><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="../operator___idp62241568.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../private_node_allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../private_node_allocator.html#idp273028816"><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="../operator___idp55126160.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/rbtree_best_fit.html b/doc/html/boost/interprocess/rbtree_best_fit.html index aa359f6417..ea09b33da6 100644 --- a/doc/html/boost/interprocess/rbtree_best_fit.html +++ b/doc/html/boost/interprocess/rbtree_best_fit.html @@ -43,100 +43,100 @@ <span class="keyword">typedef</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <a name="boost.interprocess.rbtree_best_fit.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="rbtree_best_fit.html#boost.interprocess.rbtree_best_fitconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="rbtree_best_fit.html#idp62954576-bb"><span class="identifier">rbtree_best_fit</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="rbtree_best_fit.html#idp62956848-bb"><span class="special">~</span><span class="identifier">rbtree_best_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="rbtree_best_fit.html#idp55839168-bb"><span class="identifier">rbtree_best_fit</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="rbtree_best_fit.html#idp55841440-bb"><span class="special">~</span><span class="identifier">rbtree_best_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="rbtree_best_fit.html#idp62926288-bb">public member functions</a></span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp62926848-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp62928720-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp62930576-bb"><span class="identifier">get_size</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="rbtree_best_fit.html#idp62932016-bb"><span class="identifier">get_free_memory</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp62933456-bb"><span class="identifier">zero_free_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp62934816-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp62936800-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idp62937968-bb"><span class="identifier">all_memory_deallocated</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idp62939152-bb"><span class="identifier">check_sanity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="rbtree_best_fit.html#idp55810880-bb">public member functions</a></span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp55811440-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp55813312-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp55815168-bb"><span class="identifier">get_size</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="rbtree_best_fit.html#idp55816608-bb"><span class="identifier">get_free_memory</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp55818048-bb"><span class="identifier">zero_free_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp55819408-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="rbtree_best_fit.html#idp55821392-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idp55822560-bb"><span class="identifier">all_memory_deallocated</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="rbtree_best_fit.html#idp55823744-bb"><span class="identifier">check_sanity</span></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> T<span class="special">></span> - <span class="identifier">T</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp62940464-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">T</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp55825056-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="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp62944944-bb"><span class="identifier">raw_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="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp55829536-bb"><span class="identifier">raw_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="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">&</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp62949552-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp62951696-bb"><span class="identifier">allocate_aligned</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp55834144-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="rbtree_best_fit.html#idp55836288-bb"><span class="identifier">allocate_aligned</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="rbtree_best_fit.html#idp62957424-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp62957984-bb"><span class="identifier">get_min_size</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="rbtree_best_fit.html#idp55842016-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="rbtree_best_fit.html#idp55842576-bb"><span class="identifier">get_min_size</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> <span class="comment">// public data members</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">size_type</span> <span class="identifier">PayloadPerAllocation</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp258123008"></a><h2>Description</h2> +<a name="idp276972928"></a><h2>Description</h2> <p>This class implements an algorithm that stores the free nodes in a red-black tree to have logarithmic search/insert times. </p> <div class="refsect2"> -<a name="idp258123824"></a><h3> +<a name="idp276973744"></a><h3> <a name="boost.interprocess.rbtree_best_fitconstruct-copy-destruct"></a><code class="computeroutput">rbtree_best_fit</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp62954576-bb"></a><span class="identifier">rbtree_best_fit</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">,</span> <span class="identifier">size_type</span> extra_hdr_bytes<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55839168-bb"></a><span class="identifier">rbtree_best_fit</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">,</span> <span class="identifier">size_type</span> extra_hdr_bytes<span class="special">)</span><span class="special">;</span></pre> <p>Constructor. "size" is the total size of the managed memory segment, "extra_hdr_bytes" indicates the extra bytes beginning in the sizeof(rbtree_best_fit) offset that the allocator should not use at all. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp62956848-bb"></a><span class="special">~</span><span class="identifier">rbtree_best_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destructor. </li> +<pre class="literallayout"><a name="idp55841440-bb"></a><span class="special">~</span><span class="identifier">rbtree_best_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Destructor. </li> </ol></div> </div> <div class="refsect2"> -<a name="idp258136640"></a><h3> -<a name="idp62926288-bb"></a><code class="computeroutput">rbtree_best_fit</code> public member functions</h3> +<a name="idp276986560"></a><h3> +<a name="idp55810880-bb"></a><code class="computeroutput">rbtree_best_fit</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp62926848-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">)</span><span class="special">;</span></pre>Allocates bytes, returns 0 if there is not more memory. </li> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp55811440-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">)</span><span class="special">;</span></pre>Allocates bytes, returns 0 if there is not more memory. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62928720-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> addr<span class="special">)</span><span class="special">;</span></pre>Deallocates previously allocated bytes. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55813312-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> addr<span class="special">)</span><span class="special">;</span></pre>Deallocates previously allocated bytes. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62930576-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the memory segment. </li> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55815168-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the memory segment. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62932016-bb"></a><span class="identifier">get_free_memory</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of free bytes of the segment. </li> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55816608-bb"></a><span class="identifier">get_free_memory</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the number of free bytes of the segment. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62933456-bb"></a><span class="identifier">zero_free_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55818048-bb"></a><span class="identifier">zero_free_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Initializes to zero all the memory that's not in use. This function is normally used for security reasons. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62934816-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55819408-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_size<span class="special">)</span><span class="special">;</span></pre> <p>Increases managed memory in extra_size bytes more </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62936800-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Decreases managed memory as much as possible. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55821392-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Decreases managed memory as much as possible. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62937968-bb"></a><span class="identifier">all_memory_deallocated</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns true if all allocated memory has been deallocated. </li> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55822560-bb"></a><span class="identifier">all_memory_deallocated</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Returns true if all allocated memory has been deallocated. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp62939152-bb"></a><span class="identifier">check_sanity</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp55823744-bb"></a><span class="identifier">check_sanity</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Makes an internal sanity check and returns true if success </p> </li> <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="identifier">T</span> <span class="special">*</span> <a name="idp62940464-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">T</span> <span class="special">*</span> <a name="idp55825056-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> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">&</span> reuse<span class="special">)</span><span class="special">;</span></pre></li> -<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp62944944-bb"></a><span class="identifier">raw_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> +<li class="listitem"><pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp55829536-bb"></a><span class="identifier">raw_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_object<span class="special">,</span> <span class="identifier">size_type</span> <span class="special">&</span> prefer_in_recvd_out_size<span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">&</span> reuse_ptr<span class="special">,</span> <span class="identifier">size_type</span> sizeof_object <span class="special">=</span> <span class="number">1</span><span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp62949552-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> ptr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the buffer previously allocated pointed by ptr. </li> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp55834144-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> ptr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the buffer previously allocated pointed by ptr. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp62951696-bb"></a><span class="identifier">allocate_aligned</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">,</span> <span class="identifier">size_type</span> alignment<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp55836288-bb"></a><span class="identifier">allocate_aligned</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">,</span> <span class="identifier">size_type</span> alignment<span class="special">)</span><span class="special">;</span></pre> <p>Allocates aligned bytes, returns 0 if there is not more memory. Alignment must be power of 2 </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp258231776"></a><h3> -<a name="idp62957424-bb"></a><code class="computeroutput">rbtree_best_fit</code> public static functions</h3> +<a name="idp277081888"></a><h3> +<a name="idp55842016-bb"></a><code class="computeroutput">rbtree_best_fit</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp62957984-bb"></a><span class="identifier">get_min_size</span><span class="special">(</span><span class="identifier">size_type</span> extra_hdr_bytes<span class="special">)</span><span class="special">;</span></pre>Obtains the minimum size needed by the algorithm. </li></ol></div> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp55842576-bb"></a><span class="identifier">get_min_size</span><span class="special">(</span><span class="identifier">size_type</span> extra_hdr_bytes<span class="special">)</span><span class="special">;</span></pre>Obtains the minimum size needed by the algorithm. </li></ol></div> </div> </div> </div> diff --git a/doc/html/boost/interprocess/scoped_lock.html b/doc/html/boost/interprocess/scoped_lock.html index dab51f38cd..37b85d810d 100644 --- a/doc/html/boost/interprocess/scoped_lock.html +++ b/doc/html/boost/interprocess/scoped_lock.html @@ -39,142 +39,142 @@ <span class="keyword">typedef</span> <span class="identifier">Mutex</span> <a name="boost.interprocess.scoped_lock.mutex_type"></a><span class="identifier">mutex_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="scoped_lock.html#boost.interprocess.scoped_lockconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="scoped_lock.html#idp64546800-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="scoped_lock.html#idp64548288-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_lock.html#idp64550240-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_lock.html#idp64552592-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_lock.html#idp64554960-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_lock.html#idp64557600-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_lock.html#idp64560144-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57431392-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="scoped_lock.html#idp57432880-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57434832-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57437184-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57439552-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57442192-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57444736-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</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> T<span class="special">></span> - <span class="keyword">explicit</span> <a class="link" href="scoped_lock.html#idp64565952-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="scoped_lock.html#idp57450544-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a class="link" href="scoped_lock.html#idp64575568-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57460160-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a class="link" href="scoped_lock.html#idp64581568-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> + <a class="link" href="scoped_lock.html#idp57466160-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a class="link" href="scoped_lock.html#idp64587488-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&</span> <a class="link" href="scoped_lock.html#idp64594288-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_lock.html#idp64593488-bb"><span class="special">~</span><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57472080-bb"><span class="identifier">scoped_lock</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&</span> <a class="link" href="scoped_lock.html#idp57478880-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57478080-bb"><span class="special">~</span><span class="identifier">scoped_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="scoped_lock.html#idp64526944-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="scoped_lock.html#idp64527504-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="special">*</span><span class="keyword">bool</span> <a class="link" href="scoped_lock.html#idp64529728-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="special">*</span><span class="keyword">bool</span> <a class="link" href="scoped_lock.html#idp64532144-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="special">*</span><span class="keyword">void</span> <a class="link" href="scoped_lock.html#idp64535312-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="scoped_lock.html#idp64537504-bb"><span class="identifier">owns</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="scoped_lock.html#idp64539808-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="scoped_lock.html#idp64541360-bb"><span class="identifier">mutex</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="scoped_lock.html#idp64542976-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="scoped_lock.html#idp64544368-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="scoped_lock.html#idp57411536-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="scoped_lock.html#idp57412096-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="special">*</span><span class="keyword">bool</span> <a class="link" href="scoped_lock.html#idp57414320-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="special">*</span><span class="keyword">bool</span> <a class="link" href="scoped_lock.html#idp57416736-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="special">*</span><span class="keyword">void</span> <a class="link" href="scoped_lock.html#idp57419904-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="scoped_lock.html#idp57422096-bb"><span class="identifier">owns</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="scoped_lock.html#idp57424400-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="scoped_lock.html#idp57425952-bb"><span class="identifier">mutex</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="scoped_lock.html#idp57427568-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="scoped_lock.html#idp57428960-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></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="idp267810848"></a><h2>Description</h2> +<a name="idp286664336"></a><h2>Description</h2> <p><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> is meant to carry out the tasks for locking, unlocking, try-locking and timed-locking (recursive or not) for the Mutex. The Mutex need not supply all of this functionality. If the client of scoped_lock<Mutex> does not use functionality which the Mutex does not supply, no harm is done. Mutex ownership transfer is supported through the syntax of move semantics. Ownership transfer is allowed both by construction and assignment. The <a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> does not support copy semantics. A compile time error results if copy construction or copy assignment is attempted. Mutex ownership can also be moved from an <a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> and <a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> via constructor. In this role, <a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> shares the same functionality as a write_lock. </p> <div class="refsect2"> -<a name="idp267817152"></a><h3> +<a name="idp286670640"></a><h3> <a name="boost.interprocess.scoped_lockconstruct-copy-destruct"></a><code class="computeroutput">scoped_lock</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64546800-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57431392-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Default constructs a <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code>. Postconditions: owns() == false and mutex() == 0. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp64548288-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp57432880-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre> <p>Effects: m.lock(). Postconditions: owns() == true and mutex() == &m. Notes: The constructor will take ownership of the mutex. If another thread already owns the mutex, this thread will block until the mutex is released. Whether or not this constructor handles recursive locking depends upon the mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64550240-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57434832-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span></pre> <p>Postconditions: owns() == false, and mutex() == &m. Notes: The constructor will not take ownership of the mutex. There is no effect required on the referenced mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64552592-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57437184-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span></pre> <p>Postconditions: owns() == true, and mutex() == &m. Notes: The constructor will suppose that the mutex is already locked. There is no effect required on the referenced mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64554960-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57439552-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span></pre> <p>Effects: m.try_lock(). Postconditions: mutex() == &m. owns() == the return value of the m.try_lock() executed within the constructor. Notes: The constructor will take ownership of the mutex if it can do so without waiting. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock, this constructor will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64557600-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57442192-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: m.timed_lock(abs_time). Postconditions: mutex() == &m. owns() == the return value of the m.timed_lock(abs_time) executed within the constructor. Notes: The constructor will take ownership of the mutex if it can do it until abs_time is reached. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock, this constructor will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64560144-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&&</span> scop<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57444736-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&&</span> scop<span class="special">)</span><span class="special">;</span></pre> <p>Postconditions: mutex() == the value scop.mutex() had before the constructor executes. s1.mutex() == 0. owns() == the value of scop.owns() before the constructor executes. scop.owns(). Notes: If the scop <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> owns the mutex, ownership is moved to thisscoped_lock with no blocking. If the scop <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> does not own the mutex, then neither will this <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code>. Only a moved <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code>'s will match this signature. An non-moved <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> can be moved with the expression: "boost::move(lock);". This constructor does not alter the state of the mutex, only potentially who owns it. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="keyword">explicit</span> <a name="idp64565952-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> + <span class="keyword">explicit</span> <a name="idp57450544-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If upgr.owns() then calls unlock_upgradable_and_lock() on the referenced mutex. upgr.release() is called. Postconditions: mutex() == the value upgr.mutex() had before the construction. upgr.mutex() == 0. owns() == upgr.owns() before the construction. upgr.owns() == false after the construction. Notes: If upgr is locked, this constructor will lock this <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> while unlocking upgr. If upgr is unlocked, then this <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> will be unlocked as well. Only a moved <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code>'s will match this signature. An non-moved <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code> can be moved with the expression: "boost::move(lock);" This constructor may block if other threads hold a <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> on this mutex (<code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code>'s can share ownership with an <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code>). </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a name="idp64575568-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp57460160-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If upgr.owns() then calls try_unlock_upgradable_and_lock() on the referenced mutex: a)if try_unlock_upgradable_and_lock() returns true then mutex() obtains the value from upgr.release() and owns() is set to true. b)if try_unlock_upgradable_and_lock() returns false then upgr is unaffected and this <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> construction as the same effects as a default construction. c)Else upgr.owns() is false. mutex() obtains the value from upgr.release() and owns() is set to false Notes: This construction will not block. It will try to obtain mutex ownership from upgr immediately, while changing the lock type from a "read lock" to a "write lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "write lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a name="idp64581568-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">,</span> + <a name="idp57466160-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If upgr.owns() then calls timed_unlock_upgradable_and_lock(abs_time) on the referenced mutex: a)if timed_unlock_upgradable_and_lock(abs_time) returns true then mutex() obtains the value from upgr.release() and owns() is set to true. b)if timed_unlock_upgradable_and_lock(abs_time) returns false then upgr is unaffected and this <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> construction as the same effects as a default construction. c)Else upgr.owns() is false. mutex() obtains the value from upgr.release() and owns() is set to false Notes: This construction will not block. It will try to obtain mutex ownership from upgr immediately, while changing the lock type from a "read lock" to a "write lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "write lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a name="idp64587488-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> shar<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp57472080-bb"></a><span class="identifier">scoped_lock</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> shar<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If shar.owns() then calls try_unlock_sharable_and_lock() on the referenced mutex. a)if try_unlock_sharable_and_lock() returns true then mutex() obtains the value from shar.release() and owns() is set to true. b)if try_unlock_sharable_and_lock() returns false then shar is unaffected and this <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> construction has the same effects as a default construction. c)Else shar.owns() is false. mutex() obtains the value from shar.release() and owns() is set to false Notes: This construction will not block. It will try to obtain mutex ownership from shar immediately, while changing the lock type from a "read lock" to a "write lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "write lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&</span> <a name="idp64594288-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&&</span> scop<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&</span> <a name="idp57478880-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> <span class="special">&&</span> scop<span class="special">)</span><span class="special">;</span></pre> <p>Effects: If owns() before the call, then unlock() is called on mutex(). *this gets the state of scop and scop gets set to a default constructed state. Notes: With a recursive mutex it is possible that both this and scop own the same mutex before the assignment. In this case, this will own the mutex after the assignment (and scop will not), but the mutex's lock count will be decremented by one. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64593488-bb"></a><span class="special">~</span><span class="identifier">scoped_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57478080-bb"></a><span class="special">~</span><span class="identifier">scoped_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: if (owns()) mp_mutex->unlock(). Notes: The destructor behavior ensures that the mutex lock is not leaked. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp267962336"></a><h3> -<a name="idp64526944-bb"></a><code class="computeroutput">scoped_lock</code> public member functions</h3> +<a name="idp286815888"></a><h3> +<a name="idp57411536-bb"></a><code class="computeroutput">scoped_lock</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64527504-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57412096-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls lock() on the referenced mutex. Postconditions: owns() == true. Notes: The <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> changes from a state of not owning the mutex, to owning the mutex, blocking if necessary. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="special">*</span><span class="keyword">bool</span> <a name="idp64529728-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="special">*</span><span class="keyword">bool</span> <a name="idp57414320-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls try_lock() on the referenced mutex. Postconditions: owns() == the value returned from mutex()->try_lock(). Notes: The <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> changes from a state of not owning the mutex, to owning the mutex, but only if blocking was not required. If the mutex_type does not support try_lock(), this function will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="special">*</span><span class="keyword">bool</span> <a name="idp64532144-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="special">*</span><span class="keyword">bool</span> <a name="idp57416736-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls timed_lock(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()-> timed_lock(abs_time). Notes: The <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership by the specified time. If the mutex_type does not support timed_lock (), this function will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="special">*</span><span class="keyword">void</span> <a name="idp64535312-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="special">*</span><span class="keyword">void</span> <a name="idp57419904-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or if not locked, throws a lock_exception() exception. Calls unlock() on the referenced mutex. Postconditions: owns() == false. Notes: The <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> changes from a state of owning the mutex, to not owning the mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64537504-bb"></a><span class="identifier">owns</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57422096-bb"></a><span class="identifier">owns</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Effects: Returns true if this <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> has acquired the referenced mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64539808-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57424400-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Conversion to bool. Returns owns(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp64541360-bb"></a><span class="identifier">mutex</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp57425952-bb"></a><span class="identifier">mutex</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp64542976-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp57427568-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. Postconditions: mutex() == 0 and owns() == false. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64544368-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57428960-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Effects: Swaps state with moved lock. Throws: Nothing. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/scoped_ptr.html b/doc/html/boost/interprocess/scoped_ptr.html index 7333cae166..b601aebf85 100644 --- a/doc/html/boost/interprocess/scoped_ptr.html +++ b/doc/html/boost/interprocess/scoped_ptr.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_hpp" title="Header <boost/interprocess/smart_ptr/scoped_ptr.hpp>"> -<link rel="prev" href="to_raw_pointer_idp63445232.html" title="Function template to_raw_pointer"> -<link rel="next" href="swap_idp63485808.html" title="Function template swap"> +<link rel="prev" href="to_raw_pointer_idp56329824.html" title="Function template to_raw_pointer"> +<link rel="next" href="swap_idp56370400.html" title="Function template swap"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="to_raw_pointer_idp63445232.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="swap_idp63485808.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="to_raw_pointer_idp56329824.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="swap_idp56370400.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.scoped_ptr"></a><div class="titlepage"></div> @@ -42,87 +42,87 @@ <span class="keyword">typedef</span> <span class="identifier">pointer</span> <span class="identifier">this_type</span><span class="special">::</span><span class="special">*</span> <a name="boost.interprocess.scoped_ptr.unspecified_bool_type"></a><span class="identifier">unspecified_bool_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="scoped_ptr.html#boost.interprocess.scoped_ptrconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="scoped_ptr.html#idp63481088-bb"><span class="identifier">scoped_ptr</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="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="scoped_ptr.html#idp63484800-bb"><span class="special">~</span><span class="identifier">scoped_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="scoped_ptr.html#idp56365680-bb"><span class="identifier">scoped_ptr</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="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="scoped_ptr.html#idp56369392-bb"><span class="special">~</span><span class="identifier">scoped_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="scoped_ptr.html#idp63460528-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp63461088-bb"><span class="identifier">reset</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="number">0</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp63463408-bb"><span class="identifier">reset</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="identifier">Deleter</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">pointer</span> <a class="link" href="scoped_ptr.html#idp63466128-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">reference</span> <a class="link" href="scoped_ptr.html#idp63467472-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp63469072-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp63470368-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp63471936-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp63473232-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="scoped_ptr.html#idp63474800-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="scoped_ptr.html#idp63476352-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp63477920-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="scoped_ptr.html#idp56345120-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp56345680-bb"><span class="identifier">reset</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="number">0</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp56348000-bb"><span class="identifier">reset</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="identifier">Deleter</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">pointer</span> <a class="link" href="scoped_ptr.html#idp56350720-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="scoped_ptr.html#idp56352064-bb"><span class="keyword">operator</span><span class="special">*</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp56353664-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp56354960-bb"><span class="keyword">operator</span><span class="special">-></span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp56356528-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a class="link" href="scoped_ptr.html#idp56357824-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="scoped_ptr.html#idp56359392-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="scoped_ptr.html#idp56360944-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="scoped_ptr.html#idp56362512-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> <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="idp261469632"></a><h2>Description</h2> +<a name="idp280320512"></a><h2>Description</h2> <p><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> stores a pointer to a dynamically allocated object. The object pointed to is guaranteed to be deleted, either on destruction of the <a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a>, or via an explicit reset. The user can avoid this deletion using release(). <a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> is parameterized on T (the type of the object pointed to) and Deleter (the functor to be executed to delete the internal pointer). The internal pointer will be of the same pointer type as typename Deleter::pointer type (that is, if typename Deleter::pointer is offset_ptr<void>, the internal pointer will be offset_ptr<T>). </p> <div class="refsect2"> -<a name="idp261473472"></a><h3> +<a name="idp280324352"></a><h3> <a name="boost.interprocess.scoped_ptrconstruct-copy-destruct"></a><code class="computeroutput">scoped_ptr</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp63481088-bb"></a><span class="identifier">scoped_ptr</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="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> d <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56365680-bb"></a><span class="identifier">scoped_ptr</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="number">0</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> d <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs a <code class="computeroutput"><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a></code>, storing a copy of p(which can be 0) and d. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63484800-bb"></a><span class="special">~</span><span class="identifier">scoped_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56369392-bb"></a><span class="special">~</span><span class="identifier">scoped_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>If the stored pointer is not 0, destroys the object pointed to by the stored pointer. calling the operator() of the stored deleter. Never throws </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp261494560"></a><h3> -<a name="idp63460528-bb"></a><code class="computeroutput">scoped_ptr</code> public member functions</h3> +<a name="idp280345360"></a><h3> +<a name="idp56345120-bb"></a><code class="computeroutput">scoped_ptr</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63461088-bb"></a><span class="identifier">reset</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="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56345680-bb"></a><span class="identifier">reset</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="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Deletes the object pointed to by the stored pointer and then stores a copy of p. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63463408-bb"></a><span class="identifier">reset</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="identifier">Deleter</span> <span class="special">&</span> d<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56348000-bb"></a><span class="identifier">reset</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="identifier">Deleter</span> <span class="special">&</span> d<span class="special">)</span><span class="special">;</span></pre> <p>Deletes the object pointed to by the stored pointer and then stores a copy of p and a copy of d. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp63466128-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp56350720-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Assigns internal pointer as 0 and returns previous pointer. This will avoid deletion on destructor </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">reference</span> <a name="idp63467472-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">reference</span> <a name="idp56352064-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a reference to the object pointed to by the stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp63469072-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56353664-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the internal stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp63470368-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56354960-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the internal stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp63471936-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56356528-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp63473232-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> <a name="idp56357824-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the stored pointer. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63474800-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56359392-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Conversion to bool Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63476352-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56360944-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if the stored pointer is 0. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63477920-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56362512-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre> <p>Exchanges the internal pointer and deleter with other <code class="computeroutput"><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a></code> Never throws. </p> </li> </ol></div> @@ -139,7 +139,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="to_raw_pointer_idp63445232.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="swap_idp63485808.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="to_raw_pointer_idp56329824.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="swap_idp56370400.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/segment_manager.html b/doc/html/boost/interprocess/segment_manager.html index dfe48968cf..13556ee8ec 100644 --- a/doc/html/boost/interprocess/segment_manager.html +++ b/doc/html/boost/interprocess/segment_manager.html @@ -62,207 +62,207 @@ <span class="special">}</span><span class="special">;</span> <span class="comment">// <a class="link" href="segment_manager.html#boost.interprocess.segment_managerconstruct-copy-destruct">construct/copy/destruct</a></span> - <span class="keyword">explicit</span> <a class="link" href="segment_manager.html#idp63296800-bb"><span class="identifier">segment_manager</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="segment_manager.html#idp56181392-bb"><span class="identifier">segment_manager</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="segment_manager.html#idp63230848-bb">public member functions</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<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">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">></span> <a class="link" href="segment_manager.html#idp63231408-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="segment_manager.html#idp56115440-bb">public member functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<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">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">></span> <a class="link" href="segment_manager.html#idp56116000-bb"><span class="identifier">find</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<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">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">></span> <a class="link" href="segment_manager.html#idp63234352-bb"><span class="identifier">find_no_lock</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp63237424-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</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">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">></span> <a class="link" href="segment_manager.html#idp56118944-bb"><span class="identifier">find_no_lock</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp56122016-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp63240272-bb"><span class="identifier">find_or_construct</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp56124864-bb"><span class="identifier">find_or_construct</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> - <a class="link" href="segment_manager.html#idp63243120-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="segment_manager.html#idp56127712-bb"><span class="identifier">construct</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</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> T<span class="special">></span> <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> - <a class="link" href="segment_manager.html#idp63246656-bb"><span class="identifier">find_or_construct</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="segment_manager.html#idp56131248-bb"><span class="identifier">find_or_construct</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</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> T<span class="special">></span> - <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp63250192-bb"><span class="identifier">construct_it</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp56134784-bb"><span class="identifier">construct_it</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp63252928-bb"><span class="identifier">find_or_construct_it</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp56137520-bb"><span class="identifier">find_or_construct_it</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> - <a class="link" href="segment_manager.html#idp63255792-bb"><span class="identifier">construct_it</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="segment_manager.html#idp56140384-bb"><span class="identifier">construct_it</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</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> T<span class="special">></span> <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> - <a class="link" href="segment_manager.html#idp63259344-bb"><span class="identifier">find_or_construct_it</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</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> Func<span class="special">></span> <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp63262896-bb"><span class="identifier">atomic_func</span></a><span class="special">(</span><span class="identifier">Func</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> Func<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="segment_manager.html#idp63266576-bb"><span class="identifier">try_atomic_func</span></a><span class="special">(</span><span class="identifier">Func</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> T<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="segment_manager.html#idp63269680-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp63272560-bb"><span class="identifier">destroy_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp63275408-bb"><span class="identifier">reserve_named_objects</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp63278240-bb"><span class="identifier">reserve_unique_objects</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp63281072-bb"><span class="identifier">shrink_to_fit_indexes</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="segment_manager.html#idp63282432-bb"><span class="identifier">get_num_named_objects</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="segment_manager.html#idp63283744-bb"><span class="identifier">get_num_unique_objects</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">const_named_iterator</span> <a class="link" href="segment_manager.html#idp63285056-bb"><span class="identifier">named_begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">const_named_iterator</span> <a class="link" href="segment_manager.html#idp63286704-bb"><span class="identifier">named_end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">const_unique_iterator</span> <a class="link" href="segment_manager.html#idp63288352-bb"><span class="identifier">unique_begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">const_unique_iterator</span> <a class="link" href="segment_manager.html#idp63290000-bb"><span class="identifier">unique_end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp63291648-bb"><span class="identifier">get_allocator</span></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> T<span class="special">></span> <a class="link" href="segment_manager/deleter.html" title="Struct template deleter">deleter</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp63294144-bb"><span class="identifier">get_deleter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="segment_manager.html#idp56143936-bb"><span class="identifier">find_or_construct_it</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</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> Func<span class="special">></span> <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp56147488-bb"><span class="identifier">atomic_func</span></a><span class="special">(</span><span class="identifier">Func</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> Func<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="segment_manager.html#idp56151168-bb"><span class="identifier">try_atomic_func</span></a><span class="special">(</span><span class="identifier">Func</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> T<span class="special">></span> <span class="keyword">bool</span> <a class="link" href="segment_manager.html#idp56154272-bb"><span class="identifier">destroy</span></a><span class="special">(</span><span class="identifier">char_ptr_holder_t</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp56157152-bb"><span class="identifier">destroy_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp56160000-bb"><span class="identifier">reserve_named_objects</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp56162832-bb"><span class="identifier">reserve_unique_objects</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="segment_manager.html#idp56165664-bb"><span class="identifier">shrink_to_fit_indexes</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="segment_manager.html#idp56167024-bb"><span class="identifier">get_num_named_objects</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="segment_manager.html#idp56168336-bb"><span class="identifier">get_num_unique_objects</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">const_named_iterator</span> <a class="link" href="segment_manager.html#idp56169648-bb"><span class="identifier">named_begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">const_named_iterator</span> <a class="link" href="segment_manager.html#idp56171296-bb"><span class="identifier">named_end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">const_unique_iterator</span> <a class="link" href="segment_manager.html#idp56172944-bb"><span class="identifier">unique_begin</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">const_unique_iterator</span> <a class="link" href="segment_manager.html#idp56174592-bb"><span class="identifier">unique_end</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp56176240-bb"><span class="identifier">get_allocator</span></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> T<span class="special">></span> <a class="link" href="segment_manager/deleter.html" title="Struct template deleter">deleter</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a class="link" href="segment_manager.html#idp56178736-bb"><span class="identifier">get_deleter</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="segment_manager.html#idp63298576-bb">public static functions</a></span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">CharType</span> <span class="special">*</span> <a class="link" href="segment_manager.html#idp63299136-bb"><span class="identifier">get_instance_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</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> T<span class="special">></span> <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="segment_manager.html#idp63302288-bb"><span class="identifier">get_instance_length</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</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> T<span class="special">></span> <span class="keyword">static</span> <span class="identifier">instance_type</span> <a class="link" href="segment_manager.html#idp63305440-bb"><span class="identifier">get_instance_type</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="segment_manager.html#idp63308608-bb"><span class="identifier">get_min_size</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="segment_manager.html#idp56183168-bb">public static functions</a></span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">CharType</span> <span class="special">*</span> <a class="link" href="segment_manager.html#idp56183728-bb"><span class="identifier">get_instance_name</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</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> T<span class="special">></span> <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="segment_manager.html#idp56186880-bb"><span class="identifier">get_instance_length</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</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> T<span class="special">></span> <span class="keyword">static</span> <span class="identifier">instance_type</span> <a class="link" href="segment_manager.html#idp56190032-bb"><span class="identifier">get_instance_type</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="segment_manager.html#idp56193200-bb"><span class="identifier">get_min_size</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> <span class="comment">// public data members</span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">size_type</span> <span class="identifier">PayloadPerAllocation</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp260024720"></a><h2>Description</h2> +<a name="idp278875440"></a><h2>Description</h2> <p>This object is placed in the beginning of memory segment and implements the allocation (named or anonymous) of portions of the segment. This object contains two indexes that maintain an association between a name and a portion of the segment.</p> <p>The first index contains the mappings for normal named objects using the char type specified in the template parameter.</p> <p>The second index contains the association for unique instances. The key will be the const char * returned from type_info.name() function for the unique type to be constructed.</p> <p>segment_manager<CharType, MemoryAlgorithm, IndexType> inherits publicly from segment_manager_base<MemoryAlgorithm> and inherits from it many public functions related to anonymous object and raw memory allocation. See <a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> reference to know about those functions. </p> <div class="refsect2"> -<a name="idp260028176"></a><h3> +<a name="idp278878896"></a><h3> <a name="boost.interprocess.segment_managerconstruct-copy-destruct"></a><code class="computeroutput">segment_manager</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp63296800-bb"></a><span class="identifier">segment_manager</span><span class="special">(</span><span class="identifier">size_type</span> segment_size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56181392-bb"></a><span class="identifier">segment_manager</span><span class="special">(</span><span class="identifier">size_type</span> segment_size<span class="special">)</span><span class="special">;</span></pre> <p>Constructor of the segment manager "size" is the size of the memory segment where the segment manager is being constructed. Can throw </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp260035968"></a><h3> -<a name="idp63230848-bb"></a><code class="computeroutput">segment_manager</code> public member functions</h3> +<a name="idp278886752"></a><h3> +<a name="idp56115440-bb"></a><code class="computeroutput">segment_manager</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<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">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">></span> <a name="idp63231408-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<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">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">></span> <a name="idp56116000-bb"></a><span class="identifier">find</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Tries to find a previous named/unique allocation. Returns the address and the object count. On failure the first member of the returned pair is 0. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<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">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">></span> <a name="idp63234352-bb"></a><span class="identifier">find_no_lock</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> + <span class="identifier">std</span><span class="special">::</span><span class="identifier">pair</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">size_type</span> <span class="special">></span> <a name="idp56118944-bb"></a><span class="identifier">find_no_lock</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Tries to find a previous named/unique allocation. Returns the address and the object count. On failure the first member of the returned pair is 0. This search is not mutex-protected! Use it only inside atomic_func() calls, where the internal mutex is guaranteed to be locked. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp63237424-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> + <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp56122016-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Returns throwing "construct" proxy object </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp63240272-bb"></a><span class="identifier">find_or_construct</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> + <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp56124864-bb"></a><span class="identifier">find_or_construct</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Returns throwing "search or construct" proxy object </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> - <a name="idp63243120-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp56127712-bb"></a><span class="identifier">construct</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns no throwing "construct" proxy object </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">construct_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> - <a name="idp63246656-bb"></a><span class="identifier">find_or_construct</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp56131248-bb"></a><span class="identifier">find_or_construct</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns no throwing "search or construct" proxy object </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp63250192-bb"></a><span class="identifier">construct_it</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre>Returns throwing "construct from iterators" proxy object. </li> + <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp56134784-bb"></a><span class="identifier">construct_it</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre>Returns throwing "construct from iterators" proxy object. </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp63252928-bb"></a><span class="identifier">find_or_construct_it</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> + <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp56137520-bb"></a><span class="identifier">find_or_construct_it</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Returns throwing "search or construct from iterators" proxy object </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> - <a name="idp63255792-bb"></a><span class="identifier">construct_it</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp56140384-bb"></a><span class="identifier">construct_it</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns no throwing "construct from iterators" proxy object </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="identifier">construct_iter_proxy</span><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> - <a name="idp63259344-bb"></a><span class="identifier">find_or_construct_it</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp56143936-bb"></a><span class="identifier">find_or_construct_it</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns no throwing "search or construct from iterators" proxy object </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Func<span class="special">></span> <span class="keyword">void</span> <a name="idp63262896-bb"></a><span class="identifier">atomic_func</span><span class="special">(</span><span class="identifier">Func</span> <span class="special">&</span> f<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Func<span class="special">></span> <span class="keyword">void</span> <a name="idp56147488-bb"></a><span class="identifier">atomic_func</span><span class="special">(</span><span class="identifier">Func</span> <span class="special">&</span> f<span class="special">)</span><span class="special">;</span></pre> <p>Calls object function blocking recursive <code class="computeroutput"><a class="link" href="interprocess_mutex.html" title="Class interprocess_mutex">interprocess_mutex</a></code> and guarantees that no new named_alloc or destroy will be executed by any process while executing the object function call </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Func<span class="special">></span> <span class="keyword">bool</span> <a name="idp63266576-bb"></a><span class="identifier">try_atomic_func</span><span class="special">(</span><span class="identifier">Func</span> <span class="special">&</span> f<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Func<span class="special">></span> <span class="keyword">bool</span> <a name="idp56151168-bb"></a><span class="identifier">try_atomic_func</span><span class="special">(</span><span class="identifier">Func</span> <span class="special">&</span> f<span class="special">)</span><span class="special">;</span></pre> <p>Tries to calls a functor guaranteeing that no new construction, search or destruction will be executed by any process while executing the object function call. If the atomic function can't be immediatelly executed because the internal mutex is already locked, returns false. If the functor throws, this function throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">bool</span> <a name="idp63269680-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">bool</span> <a name="idp56154272-bb"></a><span class="identifier">destroy</span><span class="special">(</span><span class="identifier">char_ptr_holder_t</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Destroys a previously created named/unique instance. Returns false if the object was not present. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="idp63272560-bb"></a><span class="identifier">destroy_ptr</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">void</span> <a name="idp56157152-bb"></a><span class="identifier">destroy_ptr</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> p<span class="special">)</span><span class="special">;</span></pre> <p>Destroys an anonymous, unique or named object using its address </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63275408-bb"></a><span class="identifier">reserve_named_objects</span><span class="special">(</span><span class="identifier">size_type</span> num<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56160000-bb"></a><span class="identifier">reserve_named_objects</span><span class="special">(</span><span class="identifier">size_type</span> num<span class="special">)</span><span class="special">;</span></pre> <p>Preallocates needed index resources to optimize the creation of "num" named objects in the managed memory segment. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63278240-bb"></a><span class="identifier">reserve_unique_objects</span><span class="special">(</span><span class="identifier">size_type</span> num<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56162832-bb"></a><span class="identifier">reserve_unique_objects</span><span class="special">(</span><span class="identifier">size_type</span> num<span class="special">)</span><span class="special">;</span></pre> <p>Preallocates needed index resources to optimize the creation of "num" unique objects in the managed memory segment. Can throw <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> if there is no enough memory. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63281072-bb"></a><span class="identifier">shrink_to_fit_indexes</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56165664-bb"></a><span class="identifier">shrink_to_fit_indexes</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Calls shrink_to_fit in both named and unique object indexes to try to free unused memory from those indexes. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp63282432-bb"></a><span class="identifier">get_num_named_objects</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp56167024-bb"></a><span class="identifier">get_num_named_objects</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the number of named objects stored in the segment. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp63283744-bb"></a><span class="identifier">get_num_unique_objects</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp56168336-bb"></a><span class="identifier">get_num_unique_objects</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the number of unique objects stored in the segment. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">const_named_iterator</span> <a name="idp63285056-bb"></a><span class="identifier">named_begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_named_iterator</span> <a name="idp56169648-bb"></a><span class="identifier">named_begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a constant iterator to the beginning of the information about the named allocations performed in this segment manager </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">const_named_iterator</span> <a name="idp63286704-bb"></a><span class="identifier">named_end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_named_iterator</span> <a name="idp56171296-bb"></a><span class="identifier">named_end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a constant iterator to the end of the information about the named allocations performed in this segment manager </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">const_unique_iterator</span> <a name="idp63288352-bb"></a><span class="identifier">unique_begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_unique_iterator</span> <a name="idp56172944-bb"></a><span class="identifier">unique_begin</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a constant iterator to the beginning of the information about the unique allocations performed in this segment manager </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">const_unique_iterator</span> <a name="idp63290000-bb"></a><span class="identifier">unique_end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">const_unique_iterator</span> <a name="idp56174592-bb"></a><span class="identifier">unique_end</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a constant iterator to the end of the information about the unique allocations performed in this segment manager </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp63291648-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="allocator.html" title="Class template allocator">allocator</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp56176240-bb"></a><span class="identifier">get_allocator</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns an instance of the default allocator for type T initialized that allocates memory from this segment manager. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="segment_manager/deleter.html" title="Struct template deleter">deleter</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp63294144-bb"></a><span class="identifier">get_deleter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="segment_manager/deleter.html" title="Struct template deleter">deleter</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="idp56178736-bb"></a><span class="identifier">get_deleter</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns an instance of the default deleter for type T that will delete an object constructed in this segment manager. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp260269760"></a><h3> -<a name="idp63298576-bb"></a><code class="computeroutput">segment_manager</code> public static functions</h3> +<a name="idp279120912"></a><h3> +<a name="idp56183168-bb"></a><code class="computeroutput">segment_manager</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">CharType</span> <span class="special">*</span> <a name="idp63299136-bb"></a><span class="identifier">get_instance_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">CharType</span> <span class="special">*</span> <a name="idp56183728-bb"></a><span class="identifier">get_instance_name</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> ptr<span class="special">)</span><span class="special">;</span></pre> <p>Returns the name of an object created with construct/find_or_construct functions. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp63302288-bb"></a><span class="identifier">get_instance_length</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp56186880-bb"></a><span class="identifier">get_instance_length</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> ptr<span class="special">)</span><span class="special">;</span></pre> <p>Returns the length of an object created with construct/find_or_construct functions. Does not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="identifier">instance_type</span> <a name="idp63305440-bb"></a><span class="identifier">get_instance_type</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> ptr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <span class="keyword">static</span> <span class="identifier">instance_type</span> <a name="idp56190032-bb"></a><span class="identifier">get_instance_type</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">T</span> <span class="special">*</span> ptr<span class="special">)</span><span class="special">;</span></pre> <p>Returns is the the name of an object created with construct/find_or_construct functions. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp63308608-bb"></a><span class="identifier">get_min_size</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp56193200-bb"></a><span class="identifier">get_min_size</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Obtains the minimum size needed by the segment manager </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/segment_manager/allocator.html b/doc/html/boost/interprocess/segment_manager/allocator.html index b5c8b2a399..7291d225dc 100644 --- a/doc/html/boost/interprocess/segment_manager/allocator.html +++ b/doc/html/boost/interprocess/segment_manager/allocator.html @@ -6,7 +6,7 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../segment_manager.html#idp260024720" title="Description"> +<link rel="up" href="../segment_manager.html#idp278875440" title="Description"> <link rel="prev" href="../segment_manager.html" title="Class template segment_manager"> <link rel="next" href="deleter.html" title="Struct template deleter"> </head> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../segment_manager.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../segment_manager.html#idp260024720"><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="deleter.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../segment_manager.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../segment_manager.html#idp278875440"><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="deleter.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.segment_manager.allocator"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <span class="keyword">typedef</span> <a class="link" href="../allocator.html" title="Class template allocator">boost::interprocess::allocator</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <a class="link" href="../segment_manager.html" title="Class template segment_manager">segment_manager</a> <span class="special">></span> <a name="boost.interprocess.segment_manager.allocator.type"></a><span class="identifier">type</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp260325488"></a><h2>Description</h2> +<a name="idp279176512"></a><h2>Description</h2> <p>This is the default allocator to allocate types T from this managed segment </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="../segment_manager.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../segment_manager.html#idp260024720"><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="deleter.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="../segment_manager.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../segment_manager.html#idp278875440"><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="deleter.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/segment_manager/deleter.html b/doc/html/boost/interprocess/segment_manager/deleter.html index 637091b5a3..04047ad883 100644 --- a/doc/html/boost/interprocess/segment_manager/deleter.html +++ b/doc/html/boost/interprocess/segment_manager/deleter.html @@ -6,7 +6,7 @@ <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css"> <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../segment_manager.html#idp260024720" title="Description"> +<link rel="up" href="../segment_manager.html#idp278875440" title="Description"> <link rel="prev" href="allocator.html" title="Struct template allocator"> <link rel="next" href="../shared_memory_object.html" title="Class shared_memory_object"> </head> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../segment_manager.html#idp260024720"><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="../shared_memory_object.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../segment_manager.html#idp278875440"><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="../shared_memory_object.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.segment_manager.deleter"></a><div class="titlepage"></div> @@ -39,7 +39,7 @@ <span class="keyword">typedef</span> <a class="link" href="../deleter.html" title="Class template deleter">boost::interprocess::deleter</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <a class="link" href="../segment_manager.html" title="Class template segment_manager">segment_manager</a> <span class="special">></span> <a name="boost.interprocess.segment_manager.deleter.type"></a><span class="identifier">type</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp260343232"></a><h2>Description</h2> +<a name="idp279194256"></a><h2>Description</h2> <p>This is the default deleter to delete types T from this managed segment. </p> </div> </div> @@ -53,7 +53,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../segment_manager.html#idp260024720"><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="../shared_memory_object.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="allocator.html"><img src="../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../segment_manager.html#idp278875440"><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="../shared_memory_object.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/segment_manager_base.html b/doc/html/boost/interprocess/segment_manager_base.html index 397951167c..f197e51305 100644 --- a/doc/html/boost/interprocess/segment_manager_base.html +++ b/doc/html/boost/interprocess/segment_manager_base.html @@ -42,40 +42,40 @@ <span class="keyword">typedef</span> <span class="identifier">MemoryAlgorithm</span> <a name="boost.interprocess.segment_manager_base.memory_algorithm"></a><span class="identifier">memory_algorithm</span><span class="special">;</span> <span class="comment">// <a class="link" href="segment_manager_base.html#boost.interprocess.segment_manager_baseconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="segment_manager_base.html#idp63202176-bb"><span class="identifier">segment_manager_base</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="segment_manager_base.html#idp56086768-bb"><span class="identifier">segment_manager_base</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="segment_manager_base.html#idp63174512-bb">public member functions</a></span> - <span class="identifier">size_type</span> <a class="link" href="segment_manager_base.html#idp63175072-bb"><span class="identifier">get_size</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="segment_manager_base.html#idp63176624-bb"><span class="identifier">get_free_memory</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="segment_manager_base.html#idp63178192-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="segment_manager_base.html#idp63180912-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="segment_manager_base.html#idp63183632-bb"><span class="identifier">allocate_aligned</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="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="segment_manager_base.html#idp63187040-bb"><span class="identifier">allocate_aligned</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="segment_manager_base.html#idp63190496-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="segment_manager_base.html#idp63192512-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="segment_manager_base.html#idp63194544-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="segment_manager_base.html#idp63195888-bb"><span class="identifier">all_memory_deallocated</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="segment_manager_base.html#idp63197216-bb"><span class="identifier">check_sanity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="segment_manager_base.html#idp63198544-bb"><span class="identifier">zero_free_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="identifier">size_type</span> <a class="link" href="segment_manager_base.html#idp63199872-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="comment">// <a class="link" href="segment_manager_base.html#idp56059104-bb">public member functions</a></span> + <span class="identifier">size_type</span> <a class="link" href="segment_manager_base.html#idp56059664-bb"><span class="identifier">get_size</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="segment_manager_base.html#idp56061216-bb"><span class="identifier">get_free_memory</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="segment_manager_base.html#idp56062784-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="segment_manager_base.html#idp56065504-bb"><span class="identifier">allocate</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="segment_manager_base.html#idp56068224-bb"><span class="identifier">allocate_aligned</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="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <span class="special">*</span> <a class="link" href="segment_manager_base.html#idp56071632-bb"><span class="identifier">allocate_aligned</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="segment_manager_base.html#idp56075088-bb"><span class="identifier">deallocate</span></a><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="segment_manager_base.html#idp56077104-bb"><span class="identifier">grow</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="segment_manager_base.html#idp56079136-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="segment_manager_base.html#idp56080480-bb"><span class="identifier">all_memory_deallocated</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="segment_manager_base.html#idp56081808-bb"><span class="identifier">check_sanity</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="segment_manager_base.html#idp56083136-bb"><span class="identifier">zero_free_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">size_type</span> <a class="link" href="segment_manager_base.html#idp56084464-bb"><span class="identifier">size</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="comment">// <a class="link" href="segment_manager_base.html#idp63205936-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="segment_manager_base.html#idp63206496-bb"><span class="identifier">get_min_size</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="segment_manager_base.html#idp56090528-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="identifier">size_type</span> <a class="link" href="segment_manager_base.html#idp56091088-bb"><span class="identifier">get_min_size</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> <span class="comment">// <a class="link" href="segment_manager_base.html#boost.interprocess.segment_manager_basepublic-data-members">public data members</a></span> <span class="keyword">static</span> <span class="keyword">const</span> <span class="identifier">size_type</span> <a class="link" href="segment_manager_base.html#boost.interprocess.segment_manager_base.PayloadPerAllocation"><span class="identifier">PayloadPerAllocation</span></a><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp259569856"></a><h2>Description</h2> +<a name="idp278420080"></a><h2>Description</h2> <p>This object is the public base class of segment manager. This class only depends on the memory allocation algorithm and implements all the allocation features not related to named or unique objects.</p> <p>Storing a reference to <a class="link" href="segment_manager.html" title="Class template segment_manager">segment_manager</a> forces the holder class to be dependent on index types and character types. When such dependence is not desirable and only anonymous and raw allocations are needed, <a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> is the correct answer. </p> <div class="refsect2"> -<a name="idp259572912"></a><h3> +<a name="idp278423136"></a><h3> <a name="boost.interprocess.segment_manager_baseconstruct-copy-destruct"></a><code class="computeroutput">segment_manager_base</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp63202176-bb"></a><span class="identifier">segment_manager_base</span><span class="special">(</span><span class="identifier">size_type</span> sz<span class="special">,</span> <span class="identifier">size_type</span> reserved_bytes<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56086768-bb"></a><span class="identifier">segment_manager_base</span><span class="special">(</span><span class="identifier">size_type</span> sz<span class="special">,</span> <span class="identifier">size_type</span> reserved_bytes<span class="special">)</span><span class="special">;</span></pre> <p>Constructor of the <code class="computeroutput"><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a></code></p> <p>"size" is the size of the memory segment where the basic segment manager is being constructed.</p> <p>"reserved_bytes" is the number of bytes after the end of the memory algorithm object itself that the memory algorithm will exclude from dynamic allocation</p> @@ -83,72 +83,72 @@ </li></ol></div> </div> <div class="refsect2"> -<a name="idp259583360"></a><h3> -<a name="idp63174512-bb"></a><code class="computeroutput">segment_manager_base</code> public member functions</h3> +<a name="idp278433680"></a><h3> +<a name="idp56059104-bb"></a><code class="computeroutput">segment_manager_base</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp63175072-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp56059664-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the size of the memory segment </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp63176624-bb"></a><span class="identifier">get_free_memory</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp56061216-bb"></a><span class="identifier">get_free_memory</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the number of free bytes of the memory segment </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp63178192-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp56062784-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates nbytes bytes. This function is only used in single-segment management. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp63180912-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp56065504-bb"></a><span class="identifier">allocate</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">)</span><span class="special">;</span></pre> <p>Allocates nbytes bytes. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">boost::interprocess::bad_alloc</a></code> on failure </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp63183632-bb"></a><span class="identifier">allocate_aligned</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">,</span> <span class="identifier">size_type</span> alignment<span class="special">,</span> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp56068224-bb"></a><span class="identifier">allocate_aligned</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">,</span> <span class="identifier">size_type</span> alignment<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">nothrow_t</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span></pre> <p>Allocates nbytes bytes. This function is only used in single-segment management. Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp63187040-bb"></a><span class="identifier">allocate_aligned</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">,</span> <span class="identifier">size_type</span> alignment<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <span class="special">*</span> <a name="idp56071632-bb"></a><span class="identifier">allocate_aligned</span><span class="special">(</span><span class="identifier">size_type</span> nbytes<span class="special">,</span> <span class="identifier">size_type</span> alignment<span class="special">)</span><span class="special">;</span></pre> <p>Allocates nbytes bytes. This function is only used in single-segment management. Throws <code class="computeroutput"><a class="link" href="bad_alloc.html" title="Class bad_alloc">bad_alloc</a></code> when fails </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63190496-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> addr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56075088-bb"></a><span class="identifier">deallocate</span><span class="special">(</span><span class="keyword">void</span> <span class="special">*</span> addr<span class="special">)</span><span class="special">;</span></pre> <p>Deallocates the bytes allocated with allocate/allocate_many() pointed by addr </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63192512-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56077104-bb"></a><span class="identifier">grow</span><span class="special">(</span><span class="identifier">size_type</span> extra_size<span class="special">)</span><span class="special">;</span></pre> <p>Increases managed memory in extra_size bytes more. This only works with single-segment management. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63194544-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56079136-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Decreases managed memory to the minimum. This only works with single-segment management. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63195888-bb"></a><span class="identifier">all_memory_deallocated</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56080480-bb"></a><span class="identifier">all_memory_deallocated</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the result of "all_memory_deallocated()" function of the used memory algorithm </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63197216-bb"></a><span class="identifier">check_sanity</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56081808-bb"></a><span class="identifier">check_sanity</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Returns the result of "check_sanity()" function of the used memory algorithm </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63198544-bb"></a><span class="identifier">zero_free_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56083136-bb"></a><span class="identifier">zero_free_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Writes to zero free memory (memory not yet allocated) of the memory algorithm </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp63199872-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> ptr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the buffer previously allocated pointed by ptr. </li> +<pre class="literallayout"><span class="identifier">size_type</span> <a name="idp56084464-bb"></a><span class="identifier">size</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">void</span> <span class="special">*</span> ptr<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the size of the buffer previously allocated pointed by ptr. </li> </ol></div> </div> <div class="refsect2"> -<a name="idp259669776"></a><h3> -<a name="idp63205936-bb"></a><code class="computeroutput">segment_manager_base</code> public static functions</h3> +<a name="idp278520240"></a><h3> +<a name="idp56090528-bb"></a><code class="computeroutput">segment_manager_base</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp63206496-bb"></a><span class="identifier">get_min_size</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="identifier">size_type</span> <a name="idp56091088-bb"></a><span class="identifier">get_min_size</span><span class="special">(</span><span class="identifier">size_type</span> size<span class="special">)</span><span class="special">;</span></pre> <p>Obtains the minimum size needed by the segment manager </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp259678000"></a><h3> +<a name="idp278528336"></a><h3> <a name="boost.interprocess.segment_manager_basepublic-data-members"></a><code class="computeroutput">segment_manager_base</code> public public data members</h3> diff --git a/doc/html/boost/interprocess/sharable_lock.html b/doc/html/boost/interprocess/sharable_lock.html index 9e07ed2809..e44b131790 100644 --- a/doc/html/boost/interprocess/sharable_lock.html +++ b/doc/html/boost/interprocess/sharable_lock.html @@ -39,123 +39,123 @@ <span class="keyword">typedef</span> <span class="identifier">SharableMutex</span> <a name="boost.interprocess.sharable_lock.mutex_type"></a><span class="identifier">mutex_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="sharable_lock.html#boost.interprocess.sharable_lockconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="sharable_lock.html#idp64627568-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="sharable_lock.html#idp64629056-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="sharable_lock.html#idp64631872-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span> - <a class="link" href="sharable_lock.html#idp64634224-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span> - <a class="link" href="sharable_lock.html#idp64636592-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span> - <a class="link" href="sharable_lock.html#idp64639264-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="sharable_lock.html#idp64641840-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</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> T<span class="special">></span> <a class="link" href="sharable_lock.html#idp64648320-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="sharable_lock.html#idp64654592-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> <span class="special">&</span> <a class="link" href="sharable_lock.html#idp64661696-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="sharable_lock.html#idp64660880-bb"><span class="special">~</span><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="sharable_lock.html#idp57512160-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="sharable_lock.html#idp57513648-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="sharable_lock.html#idp57516464-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span> + <a class="link" href="sharable_lock.html#idp57518816-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span> + <a class="link" href="sharable_lock.html#idp57521184-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span> + <a class="link" href="sharable_lock.html#idp57523856-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="sharable_lock.html#idp57526432-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</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> T<span class="special">></span> <a class="link" href="sharable_lock.html#idp57532912-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a class="link" href="sharable_lock.html#idp57539184-bb"><span class="identifier">sharable_lock</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> <span class="special">&</span> <a class="link" href="sharable_lock.html#idp57546288-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="sharable_lock.html#idp57545472-bb"><span class="special">~</span><span class="identifier">sharable_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="sharable_lock.html#idp64607616-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="sharable_lock.html#idp64608176-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="sharable_lock.html#idp64610416-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="sharable_lock.html#idp64612864-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="sharable_lock.html#idp64616064-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="sharable_lock.html#idp64618272-bb"><span class="identifier">owns</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="sharable_lock.html#idp64620576-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="sharable_lock.html#idp64622128-bb"><span class="identifier">mutex</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="sharable_lock.html#idp64623744-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="sharable_lock.html#idp64625136-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="sharable_lock.html#idp57492208-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="sharable_lock.html#idp57492768-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="sharable_lock.html#idp57495008-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="sharable_lock.html#idp57497456-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="sharable_lock.html#idp57500656-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="sharable_lock.html#idp57502864-bb"><span class="identifier">owns</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="sharable_lock.html#idp57505168-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="sharable_lock.html#idp57506720-bb"><span class="identifier">mutex</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="sharable_lock.html#idp57508336-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="sharable_lock.html#idp57509728-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></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="idp268174832"></a><h2>Description</h2> +<a name="idp287028192"></a><h2>Description</h2> <p><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> is meant to carry out the tasks for sharable-locking (such as read-locking), unlocking, try-sharable-locking and timed-sharable-locking (recursive or not) for the Mutex. The Mutex need not supply all of this functionality. If the client of sharable_lock<Mutex> does not use functionality which the Mutex does not supply, no harm is done. Mutex ownership can be shared among sharable_locks, and a single <a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a>. <a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> does not support copy semantics. But <a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> supports ownership transfer from an <a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a>, <a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> and <a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> via transfer_lock syntax. </p> <div class="refsect2"> -<a name="idp268181856"></a><h3> +<a name="idp287035216"></a><h3> <a name="boost.interprocess.sharable_lockconstruct-copy-destruct"></a><code class="computeroutput">sharable_lock</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64627568-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57512160-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Default constructs a <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code>. Postconditions: owns() == false and mutex() == 0. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp64629056-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp57513648-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre> <p>Effects: m.lock_sharable(). Postconditions: owns() == true and mutex() == &m. Notes: The constructor will take sharable-ownership of the mutex. If another thread already owns the mutex with exclusive ownership (<code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code>), this thread will block until the mutex is released. If another thread owns the mutex with sharable or upgradable ownership, then no blocking will occur. Whether or not this constructor handles recursive locking depends upon the mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64631872-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57516464-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span></pre> <p>Postconditions: owns() == false, and mutex() == &m. Notes: The constructor will not take ownership of the mutex. There is no effect required on the referenced mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64634224-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57518816-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span></pre> <p>Postconditions: owns() == true, and mutex() == &m. Notes: The constructor will suppose that the mutex is already sharable locked. There is no effect required on the referenced mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64636592-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57521184-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span></pre> <p>Effects: m.try_lock_sharable() Postconditions: mutex() == &m. owns() == the return value of the m.try_lock_sharable() executed within the constructor. Notes: The constructor will take sharable-ownership of the mutex if it can do so without waiting. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock_sharable, this constructor will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64639264-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57523856-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: m.timed_lock_sharable(abs_time) Postconditions: mutex() == &m. owns() == the return value of the m.timed_lock_sharable() executed within the constructor. Notes: The constructor will take sharable-ownership of the mutex if it can do so within the time specified. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support timed_lock_sharable, this constructor will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64641840-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57526432-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">)</span><span class="special">;</span></pre> <p>Postconditions: mutex() == upgr.mutex(). owns() == the value of upgr.owns() before the construction. upgr.owns() == false after the construction. Notes: If the upgr <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> owns the mutex, ownership is moved to this <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> with no blocking. If the upgr <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> does not own the mutex, then neither will this <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code>. Only a moved <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code>'s will match this signature. An non-moved <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> can be moved with the expression: "boost::move(lock);". This constructor does not alter the state of the mutex, only potentially who owns it. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a name="idp64648320-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp57532912-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If upgr.owns() then calls unlock_upgradable_and_lock_sharable() on the referenced mutex. Postconditions: mutex() == the value upgr.mutex() had before the construction. upgr.mutex() == 0 owns() == the value of upgr.owns() before construction. upgr.owns() == false after the construction. Notes: If upgr is locked, this constructor will lock this <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> while unlocking upgr. Only a moved <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code>'s will match this signature. An non-moved <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code> can be moved with the expression: "boost::move(lock);". </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a name="idp64654592-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> scop<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> <a name="idp57539184-bb"></a><span class="identifier">sharable_lock</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> scop<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If scop.owns() then calls unlock_and_lock_sharable() on the referenced mutex. Postconditions: mutex() == the value scop.mutex() had before the construction. scop.mutex() == 0 owns() == scop.owns() before the constructor. After the construction, scop.owns() == false. Notes: If scop is locked, this constructor will transfer the exclusive ownership to a sharable-ownership of this <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code>. Only a moved <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code>'s will match this signature. An non-moved <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> can be moved with the expression: "boost::move(lock);". </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> <span class="special">&</span> <a name="idp64661696-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a> <span class="special">&</span> <a name="idp57546288-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">)</span><span class="special">;</span></pre> <p>Effects: If owns() before the call, then unlock_sharable() is called on mutex(). *this gets the state of upgr and upgr gets set to a default constructed state. Notes: With a recursive mutex it is possible that both this and upgr own the mutex before the assignment. In this case, this will own the mutex after the assignment (and upgr will not), but the mutex's lock count will be decremented by one. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64660880-bb"></a><span class="special">~</span><span class="identifier">sharable_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57545472-bb"></a><span class="special">~</span><span class="identifier">sharable_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: if (owns()) mp_mutex->unlock_sharable(). Notes: The destructor behavior ensures that the mutex lock is not leaked. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp268293968"></a><h3> -<a name="idp64607616-bb"></a><code class="computeroutput">sharable_lock</code> public member functions</h3> +<a name="idp287147024"></a><h3> +<a name="idp57492208-bb"></a><code class="computeroutput">sharable_lock</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64608176-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57492768-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or already locked, throws a lock_exception() exception. Calls lock_sharable() on the referenced mutex. Postconditions: owns() == true. Notes: The <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> changes from a state of not owning the mutex, to owning the mutex, blocking if necessary. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64610416-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57495008-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or already locked, throws a lock_exception() exception. Calls try_lock_sharable() on the referenced mutex. Postconditions: owns() == the value returned from mutex()->try_lock_sharable(). Notes: The <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> changes from a state of not owning the mutex, to owning the mutex, but only if blocking was not required. If the mutex_type does not support try_lock_sharable(), this function will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64612864-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57497456-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or already locked, throws a lock_exception() exception. Calls timed_lock_sharable(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()->timed_lock_sharable(elps_time). Notes: The <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership within the specified time interval. If the mutex_type does not support timed_lock_sharable(), this function will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64616064-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57500656-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or not locked, throws a lock_exception() exception. Calls unlock_sharable() on the referenced mutex. Postconditions: owns() == false. Notes: The <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> changes from a state of owning the mutex, to not owning the mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64618272-bb"></a><span class="identifier">owns</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57502864-bb"></a><span class="identifier">owns</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Effects: Returns true if this <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> has acquired the referenced mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64620576-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57505168-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Conversion to bool. Returns owns(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp64622128-bb"></a><span class="identifier">mutex</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp57506720-bb"></a><span class="identifier">mutex</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp64623744-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp57508336-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. Postconditions: mutex() == 0 and owns() == false. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64625136-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57509728-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Effects: Swaps state with moved lock. Throws: Nothing. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/shared_memory_object.html b/doc/html/boost/interprocess/shared_memory_object.html index 96e1d89690..367121ac91 100644 --- a/doc/html/boost/interprocess/shared_memory_object.html +++ b/doc/html/boost/interprocess/shared_memory_object.html @@ -36,91 +36,91 @@ <span class="keyword">class</span> <a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="shared_memory_object.html#boost.interprocess.shared_memory_objectconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="shared_memory_object.html#idp63325264-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_memory_object.html#idp63326624-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">,</span> + <a class="link" href="shared_memory_object.html#idp56209856-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_memory_object.html#idp56211216-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_memory_object.html#idp63331648-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">,</span> + <a class="link" href="shared_memory_object.html#idp56216240-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_memory_object.html#idp63336720-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_memory_object.html#idp63339744-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&</span> <a class="link" href="shared_memory_object.html#idp63341552-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_memory_object.html#idp63343920-bb"><span class="special">~</span><span class="identifier">shared_memory_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_memory_object.html#idp56221312-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_memory_object.html#idp56224336-bb"><span class="identifier">shared_memory_object</span></a><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&</span> <a class="link" href="shared_memory_object.html#idp56226144-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_memory_object.html#idp56228512-bb"><span class="special">~</span><span class="identifier">shared_memory_object</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="shared_memory_object.html#idp63313952-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="shared_memory_object.html#idp63314512-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="shared_memory_object.html#idp63316656-bb"><span class="identifier">truncate</span></a><span class="special">(</span><span class="identifier">offset_t</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="shared_memory_object.html#idp63318512-bb"><span class="identifier">get_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="shared_memory_object.html#idp63319952-bb"><span class="identifier">get_size</span></a><span class="special">(</span><span class="identifier">offset_t</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mode_t</span> <a class="link" href="shared_memory_object.html#idp63322272-bb"><span class="identifier">get_mode</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mapping_handle_t</span> <a class="link" href="shared_memory_object.html#idp63323680-bb"><span class="identifier">get_mapping_handle</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="shared_memory_object.html#idp56198544-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="shared_memory_object.html#idp56199104-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="shared_memory_object.html#idp56201248-bb"><span class="identifier">truncate</span></a><span class="special">(</span><span class="identifier">offset_t</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="shared_memory_object.html#idp56203104-bb"><span class="identifier">get_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="shared_memory_object.html#idp56204544-bb"><span class="identifier">get_size</span></a><span class="special">(</span><span class="identifier">offset_t</span> <span class="special">&</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mode_t</span> <a class="link" href="shared_memory_object.html#idp56206864-bb"><span class="identifier">get_mode</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mapping_handle_t</span> <a class="link" href="shared_memory_object.html#idp56208272-bb"><span class="identifier">get_mapping_handle</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="shared_memory_object.html#idp63345008-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="shared_memory_object.html#idp63345568-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="shared_memory_object.html#idp56229600-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="shared_memory_object.html#idp56230160-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</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="idp260451824"></a><h2>Description</h2> +<a name="idp279302752"></a><h2>Description</h2> <p>A class that wraps a shared memory mapping that can be used to create mapped regions from the mapped files </p> <div class="refsect2"> -<a name="idp260452624"></a><h3> +<a name="idp279303552"></a><h3> <a name="boost.interprocess.shared_memory_objectconstruct-copy-destruct"></a><code class="computeroutput">shared_memory_object</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63325264-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. Represents an empty <code class="computeroutput"><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a></code>. </li> +<pre class="literallayout"><a name="idp56209856-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre>Default constructor. Represents an empty <code class="computeroutput"><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a></code>. </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63326624-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> +<pre class="literallayout"><a name="idp56211216-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a shared memory object with name "name" and mode "mode", with the access mode "mode" If the file previously exists, throws an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63331648-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> +<pre class="literallayout"><a name="idp56216240-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Tries to create a shared memory object with name "name" and mode "mode", with the access mode "mode". If the file previously exists, it tries to open it with mode "mode". Otherwise throws an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63336720-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56221312-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">)</span><span class="special">;</span></pre> <p>Tries to open a shared memory object with name "name", with the access mode "mode". If the file does not previously exist, it throws an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63339744-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56224336-bb"></a><span class="identifier">shared_memory_object</span><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s shared memory object to *this. After the call, "moved" does not represent any shared memory object. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&</span> <a name="idp63341552-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&</span> <a name="idp56226144-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s shared memory to *this. After the call, "moved" does not represent any shared memory. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63343920-bb"></a><span class="special">~</span><span class="identifier">shared_memory_object</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56228512-bb"></a><span class="special">~</span><span class="identifier">shared_memory_object</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this and indicates that the calling process is finished using the resource. All mapped regions are still valid after destruction. The destructor function will deallocate any system resources allocated by the system for use by this process for this resource. The resource can still be opened again calling the open constructor overload. To erase the resource from the system use remove(). </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp260515104"></a><h3> -<a name="idp63313952-bb"></a><code class="computeroutput">shared_memory_object</code> public member functions</h3> +<a name="idp279365968"></a><h3> +<a name="idp56198544-bb"></a><code class="computeroutput">shared_memory_object</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63314512-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&</span> moved<span class="special">)</span><span class="special">;</span></pre>Swaps the shared_memory_objects. Does not throw. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56199104-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a> <span class="special">&</span> moved<span class="special">)</span><span class="special">;</span></pre>Swaps the shared_memory_objects. Does not throw. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63316656-bb"></a><span class="identifier">truncate</span><span class="special">(</span><span class="identifier">offset_t</span> length<span class="special">)</span><span class="special">;</span></pre>Sets the size of the shared memory mapping. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56201248-bb"></a><span class="identifier">truncate</span><span class="special">(</span><span class="identifier">offset_t</span> length<span class="special">)</span><span class="special">;</span></pre>Sets the size of the shared memory mapping. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp63318512-bb"></a><span class="identifier">get_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the name of the shared memory object. </li> +<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp56203104-bb"></a><span class="identifier">get_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the name of the shared memory object. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63319952-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="identifier">offset_t</span> <span class="special">&</span> size<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56204544-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="identifier">offset_t</span> <span class="special">&</span> size<span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns true if the size of the shared memory object can be obtained and writes the size in the passed reference </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mode_t</span> <a name="idp63322272-bb"></a><span class="identifier">get_mode</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns access mode. </li> +<pre class="literallayout"><span class="identifier">mode_t</span> <a name="idp56206864-bb"></a><span class="identifier">get_mode</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns access mode. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idp63323680-bb"></a><span class="identifier">get_mapping_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns mapping handle. Never throws. </li> +<pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idp56208272-bb"></a><span class="identifier">get_mapping_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns mapping handle. Never throws. </li> </ol></div> </div> <div class="refsect2"> -<a name="idp260551904"></a><h3> -<a name="idp63345008-bb"></a><code class="computeroutput">shared_memory_object</code> public static functions</h3> +<a name="idp279402944"></a><h3> +<a name="idp56229600-bb"></a><code class="computeroutput">shared_memory_object</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp63345568-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp56230160-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">)</span><span class="special">;</span></pre> <p>Erases a shared memory object from the system. Returns false on error. Never throws </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/shared_ptr.html b/doc/html/boost/interprocess/shared_ptr.html index dc27233c86..59a247b679 100644 --- a/doc/html/boost/interprocess/shared_ptr.html +++ b/doc/html/boost/interprocess/shared_ptr.html @@ -45,140 +45,140 @@ <span class="keyword">typedef</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">intrusive</span><span class="special">::</span><span class="identifier">pointer_traits</span><span class="special"><</span> <span class="keyword">typename</span> <span class="identifier">VoidAllocator</span><span class="special">::</span><span class="identifier">pointer</span> <span class="special">></span><span class="special">::</span><span class="keyword">template</span> <span class="identifier">rebind_pointer</span><span class="special"><</span> <span class="keyword">const</span> <span class="identifier">VoidAllocator</span> <span class="special">></span><span class="special">::</span><span class="identifier">type</span> <a name="boost.interprocess.shared_ptr.const_allocator_pointer"></a><span class="identifier">const_allocator_pointer</span><span class="special">;</span> <span class="comment">// <a class="link" href="shared_ptr.html#boost.interprocess.shared_ptrconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="shared_ptr.html#idp63544624-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="shared_ptr.html#idp63546080-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span><span class="special">,</span> + <a class="link" href="shared_ptr.html#idp56429216-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="shared_ptr.html#idp56430672-bb"><span class="identifier">shared_ptr</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="identifier">VoidAllocator</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">VoidAllocator</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_ptr.html#idp63550608-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_ptr.html#idp63554720-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <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="special">;</span> + <a class="link" href="shared_ptr.html#idp56435200-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_ptr.html#idp56439312-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><span class="keyword">const</span> <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <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="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> - <a class="link" href="shared_ptr.html#idp63558096-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_ptr.html#idp56442688-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</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> Y<span class="special">></span> - <span class="keyword">explicit</span> <a class="link" href="shared_ptr.html#idp63562176-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="shared_ptr.html#idp63565792-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="shared_ptr.html#idp56446768-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="shared_ptr.html#idp56450384-bb"><span class="identifier">shared_ptr</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</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> Y<span class="special">></span> - <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a class="link" href="shared_ptr.html#idp63568576-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a class="link" href="shared_ptr.html#idp63571728-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">BOOST_COPY_ASSIGN_REF</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a class="link" href="shared_ptr.html#idp63574176-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a class="link" href="shared_ptr.html#idp56453168-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a class="link" href="shared_ptr.html#idp56456320-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><span class="identifier">BOOST_COPY_ASSIGN_REF</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special">)</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a class="link" href="shared_ptr.html#idp56458768-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="shared_ptr.html#idp63521808-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="shared_ptr.html#idp63522368-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="shared_ptr.html#idp56406400-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="shared_ptr.html#idp56406960-bb"><span class="identifier">reset</span></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> Pointer<span class="special">></span> - <span class="keyword">void</span> <a class="link" href="shared_ptr.html#idp63523664-bb"><span class="identifier">reset</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="identifier">VoidAllocator</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">VoidAllocator</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> + <span class="keyword">void</span> <a class="link" href="shared_ptr.html#idp56408256-bb"><span class="identifier">reset</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="identifier">VoidAllocator</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">VoidAllocator</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> <span class="special">=</span> <span class="identifier">Deleter</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> Y<span class="special">></span> - <span class="keyword">void</span> <a class="link" href="shared_ptr.html#idp63528448-bb"><span class="identifier">reset</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">,</span> + <span class="keyword">void</span> <a class="link" href="shared_ptr.html#idp56413040-bb"><span class="identifier">reset</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</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="special">;</span> - <span class="identifier">reference</span> <a class="link" href="shared_ptr.html#idp63531824-bb"><span class="keyword">operator</span><span class="special">*</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="shared_ptr.html#idp63533392-bb"><span class="keyword">operator</span><span class="special">-></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="shared_ptr.html#idp63534960-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="shared_ptr.html#idp63536528-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="shared_ptr.html#idp63538112-bb"><span class="identifier">unique</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">long</span> <a class="link" href="shared_ptr.html#idp63539696-bb"><span class="identifier">use_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="shared_ptr.html#idp63542176-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="identifier">reference</span> <a class="link" href="shared_ptr.html#idp56416416-bb"><span class="keyword">operator</span><span class="special">*</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="shared_ptr.html#idp56417984-bb"><span class="keyword">operator</span><span class="special">-></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="shared_ptr.html#idp56419552-bb"><span class="identifier">get</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="shared_ptr.html#idp56421120-bb"><span class="keyword">operator</span><span class="special">!</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="shared_ptr.html#idp56422704-bb"><span class="identifier">unique</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">long</span> <a class="link" href="shared_ptr.html#idp56424288-bb"><span class="identifier">use_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="shared_ptr.html#idp56426768-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></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="idp262176912"></a><h2>Description</h2> +<a name="idp281027904"></a><h2>Description</h2> <p><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> stores a pointer to a dynamically allocated object. The object pointed to is guaranteed to be deleted when the last <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> pointing to it is destroyed or reset.</p> <p><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> is parameterized on T (the type of the object pointed to), VoidAllocator (the void allocator to be used to allocate the auxiliary data) and Deleter (the deleter whose operator() will be used to delete the object.</p> <p>The internal pointer will be of the same pointer type as typename VoidAllocator::pointer type (that is, if typename VoidAllocator::pointer is offset_ptr<void>, the internal pointer will be offset_ptr<T>).</p> <p>Because the implementation uses reference counting, cycles of <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> instances will not be reclaimed. For example, if main() holds a <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> to A, which directly or indirectly holds a <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> back to A, A's use count will be 2. Destruction of the original <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> will leave A dangling with a use count of 1. Use <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> to "break cycles." </p> <div class="refsect2"> -<a name="idp262185872"></a><h3> +<a name="idp281036864"></a><h3> <a name="boost.interprocess.shared_ptrconstruct-copy-destruct"></a><code class="computeroutput">shared_ptr</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63544624-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56429216-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs an empty <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code>. Use_count() == 0 && get()== 0. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp63546080-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">,</span> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56430672-bb"></a><span class="identifier">shared_ptr</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="identifier">VoidAllocator</span> <span class="special">&</span> a <span class="special">=</span> <span class="identifier">VoidAllocator</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> d <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Constructs a <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code> that owns the pointer p. Auxiliary data will be allocated with a copy of a and the object will be deleted with a copy of d. Requirements: Deleter and A's copy constructor must not throw. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63550608-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56435200-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> <p>Copy constructs a <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code>. If r is empty, constructs an empty <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code>. Otherwise, constructs a <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code> that shares ownership with r. Never throws. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp63554720-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> other<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">pointer</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56439312-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><span class="keyword">const</span> <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> other<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>Constructs a <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code> that shares ownership with other and stores p. Postconditions: get() == p && use_count() == r.use_count(). Throws: nothing. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> - <a name="idp63558096-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> + <a name="idp56442688-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> <p>If r is empty, constructs an empty <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code>. Otherwise, constructs a <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code> that shares ownership with r. Never throws. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> - <span class="keyword">explicit</span> <a name="idp63562176-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> + <span class="keyword">explicit</span> <a name="idp56446768-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> <p>Constructs a <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code> that shares ownership with r and stores a copy of the pointer stored in r. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp63565792-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp56450384-bb"></a><span class="identifier">shared_ptr</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Move-Constructs a <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code> that takes ownership of other resource and other is put in default-constructed state. Throws: nothing. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> - <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a name="idp63568576-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> + <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a name="idp56453168-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> <p>Equivalent to shared_ptr(r).swap(*this). Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a name="idp63571728-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">BOOST_COPY_ASSIGN_REF</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special">)</span> r<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a name="idp56456320-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><span class="identifier">BOOST_COPY_ASSIGN_REF</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special">)</span> r<span class="special">)</span><span class="special">;</span></pre> <p>Equivalent to shared_ptr(r).swap(*this). Never throws </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a name="idp63574176-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&</span> <a name="idp56458768-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> <span class="special">&&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Move-assignment. Equivalent to shared_ptr(other).swap(*this). Never throws </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp262300624"></a><h3> -<a name="idp63521808-bb"></a><code class="computeroutput">shared_ptr</code> public member functions</h3> +<a name="idp281151568"></a><h3> +<a name="idp56406400-bb"></a><code class="computeroutput">shared_ptr</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63522368-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56406960-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>This is equivalent to: this_type().swap(*this); </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Pointer<span class="special">></span> - <span class="keyword">void</span> <a name="idp63523664-bb"></a><span class="identifier">reset</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="identifier">VoidAllocator</span> <span class="special">&</span> a <span class="special">=</span> <span class="identifier">VoidAllocator</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> + <span class="keyword">void</span> <a name="idp56408256-bb"></a><span class="identifier">reset</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="identifier">VoidAllocator</span> <span class="special">&</span> a <span class="special">=</span> <span class="identifier">VoidAllocator</span><span class="special">(</span><span class="special">)</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">Deleter</span> <span class="special">&</span> d <span class="special">=</span> <span class="identifier">Deleter</span><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>This is equivalent to: this_type(p, a, d).swap(*this); </p> </li> <li class="listitem"><pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> - <span class="keyword">void</span> <a name="idp63528448-bb"></a><span class="identifier">reset</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">,</span> + <span class="keyword">void</span> <a name="idp56413040-bb"></a><span class="identifier">reset</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<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></li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">reference</span> <a name="idp63531824-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">reference</span> <a name="idp56416416-bb"></a><span class="keyword">operator</span><span class="special">*</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns a reference to the pointed type </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp63533392-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp56417984-bb"></a><span class="keyword">operator</span><span class="special">-></span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the pointer pointing to the owned object </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp63534960-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">pointer</span> <a name="idp56419552-bb"></a><span class="identifier">get</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the pointer pointing to the owned object </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63536528-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56421120-bb"></a><span class="keyword">operator</span><span class="special">!</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Not operator. Returns true if this->get() != 0, false otherwise </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63538112-bb"></a><span class="identifier">unique</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56422704-bb"></a><span class="identifier">unique</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns use_count() == 1. unique() might be faster than use_count() </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">long</span> <a name="idp63539696-bb"></a><span class="identifier">use_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">long</span> <a name="idp56424288-bb"></a><span class="identifier">use_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the number of <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code> objects, *this included, that share ownership with *this, or an unspecified nonnegative value when *this is empty. use_count() is not necessarily efficient. Use only for debugging and testing purposes, not for production code. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63542176-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56426768-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VoidAllocator</span><span class="special">,</span> <span class="identifier">Deleter</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Exchanges the contents of the two smart pointers. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/simple_seq_fit.html b/doc/html/boost/interprocess/simple_seq_fit.html index f9e87ef294..124b4d5e0b 100644 --- a/doc/html/boost/interprocess/simple_seq_fit.html +++ b/doc/html/boost/interprocess/simple_seq_fit.html @@ -39,18 +39,18 @@ <span class="keyword">typedef</span> <span class="identifier">base_t</span><span class="special">::</span><span class="identifier">size_type</span> <a name="boost.interprocess.simple_seq_fit.size_type"></a><span class="identifier">size_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="simple_seq_fit.html#boost.interprocess.simple_seq_fitconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="simple_seq_fit.html#idp62966880-bb"><span class="identifier">simple_seq_fit</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="simple_seq_fit.html#idp55851472-bb"><span class="identifier">simple_seq_fit</span></a><span class="special">(</span><span class="identifier">size_type</span><span class="special">,</span> <span class="identifier">size_type</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp258277488"></a><h2>Description</h2> +<a name="idp277127536"></a><h2>Description</h2> <p>This class implements the simple sequential fit algorithm with a simply linked list of free buffers. </p> <div class="refsect2"> -<a name="idp258278272"></a><h3> +<a name="idp277128320"></a><h3> <a name="boost.interprocess.simple_seq_fitconstruct-copy-destruct"></a><code class="computeroutput">simple_seq_fit</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp62966880-bb"></a><span class="identifier">simple_seq_fit</span><span class="special">(</span><span class="identifier">size_type</span> segment_size<span class="special">,</span> <span class="identifier">size_type</span> extra_hdr_bytes<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55851472-bb"></a><span class="identifier">simple_seq_fit</span><span class="special">(</span><span class="identifier">size_type</span> segment_size<span class="special">,</span> <span class="identifier">size_type</span> extra_hdr_bytes<span class="special">)</span><span class="special">;</span></pre> <p>Constructor. "size" is the total size of the managed memory segment, "extra_hdr_bytes" indicates the extra bytes beginning in the sizeof(simple_seq_fit) offset that the allocator should not use at all. </p> </li></ol></div> </div> diff --git a/doc/html/boost/interprocess/swap_idp63435488.html b/doc/html/boost/interprocess/swap_idp56320080.html index c682406360..0f23a4cd61 100644 --- a/doc/html/boost/interprocess/swap_idp63435488.html +++ b/doc/html/boost/interprocess/swap_idp56320080.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> -<link rel="prev" href="operator_idp63430832.html" title="Function template operator<"> -<link rel="next" href="to_raw_pointer_idp63445232.html" title="Function template to_raw_pointer"> +<link rel="prev" href="operator_idp56315424.html" title="Function template operator<"> +<link rel="next" href="to_raw_pointer_idp56329824.html" title="Function template to_raw_pointer"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator_idp63430832.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="to_raw_pointer_idp63445232.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator_idp56315424.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="to_raw_pointer_idp56329824.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.swap_idp63435488"></a><div class="titlepage"></div> +<a name="boost.interprocess.swap_idp56320080"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template swap</span></h2> <p>boost::interprocess::swap</p> @@ -36,7 +36,7 @@ <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> VP<span class="special">></span> <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="special">&</span> lhs<span class="special">,</span> <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> <span class="special">&</span> rhs<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261294704"></a><h2>Description</h2> +<a name="idp280145584"></a><h2>Description</h2> <p>Exchanges the contents of the two intrusive_ptrs. Does not throw </p> </div> </div> @@ -50,7 +50,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="operator_idp63430832.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="to_raw_pointer_idp63445232.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="operator_idp56315424.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="to_raw_pointer_idp56329824.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/swap_idp63485808.html b/doc/html/boost/interprocess/swap_idp56370400.html index 34ca157121..44412f26ad 100644 --- a/doc/html/boost/interprocess/swap_idp63485808.html +++ b/doc/html/boost/interprocess/swap_idp56370400.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_hpp" title="Header <boost/interprocess/smart_ptr/scoped_ptr.hpp>"> <link rel="prev" href="scoped_ptr.html" title="Class template scoped_ptr"> -<link rel="next" href="to_raw_pointer_idp63491200.html" title="Function template to_raw_pointer"> +<link rel="next" href="to_raw_pointer_idp56375792.html" title="Function template to_raw_pointer"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="scoped_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="to_raw_pointer_idp63491200.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="scoped_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="to_raw_pointer_idp56375792.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.swap_idp63485808"></a><div class="titlepage"></div> +<a name="boost.interprocess.swap_idp56370400"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template swap</span></h2> <p>boost::interprocess::swap</p> @@ -36,7 +36,7 @@ <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> D<span class="special">></span> <span class="keyword">void</span> <span class="identifier">swap</span><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="special">&</span> a<span class="special">,</span> <a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="special">&</span> b<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261588560"></a><h2>Description</h2> +<a name="idp280439440"></a><h2>Description</h2> <p>Exchanges the internal pointer and deleter with other <code class="computeroutput"><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a></code> Never throws. </p> </div> </div> @@ -50,7 +50,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="scoped_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="to_raw_pointer_idp63491200.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="scoped_ptr.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="to_raw_pointer_idp56375792.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/to_raw_pointer_idp63445232.html b/doc/html/boost/interprocess/to_raw_pointer_idp56329824.html index 203ca2f348..0b6837e817 100644 --- a/doc/html/boost/interprocess/to_raw_pointer_idp63445232.html +++ b/doc/html/boost/interprocess/to_raw_pointer_idp56329824.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_hpp" title="Header <boost/interprocess/smart_ptr/intrusive_ptr.hpp>"> -<link rel="prev" href="swap_idp63435488.html" title="Function template swap"> +<link rel="prev" href="swap_idp56320080.html" title="Function template swap"> <link rel="next" href="scoped_ptr.html" title="Class template scoped_ptr"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="swap_idp63435488.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="scoped_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="swap_idp56320080.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="scoped_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.to_raw_pointer_idp63445232"></a><div class="titlepage"></div> +<a name="boost.interprocess.to_raw_pointer_idp56329824"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template to_raw_pointer</span></h2> <p>boost::interprocess::to_raw_pointer</p> @@ -37,7 +37,7 @@ <a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">boost::interprocess::intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span><span class="special">::</span><span class="identifier">pointer</span> <span class="identifier">to_raw_pointer</span><span class="special">(</span><a class="link" href="intrusive_ptr.html" title="Class template intrusive_ptr">intrusive_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">VP</span> <span class="special">></span> p<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261314352"></a><h2>Description</h2> +<a name="idp280165264"></a><h2>Description</h2> <p>Returns p.get(). Does not throw </p> </div> </div> @@ -51,7 +51,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="swap_idp63435488.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="scoped_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="swap_idp56320080.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.intrusive_ptr_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="scoped_ptr.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/to_raw_pointer_idp63491200.html b/doc/html/boost/interprocess/to_raw_pointer_idp56375792.html index cd7e4d8704..0948e39a4c 100644 --- a/doc/html/boost/interprocess/to_raw_pointer_idp63491200.html +++ b/doc/html/boost/interprocess/to_raw_pointer_idp56375792.html @@ -7,7 +7,7 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_hpp" title="Header <boost/interprocess/smart_ptr/scoped_ptr.hpp>"> -<link rel="prev" href="swap_idp63485808.html" title="Function template swap"> +<link rel="prev" href="swap_idp56370400.html" title="Function template swap"> <link rel="next" href="enable_shared_from_this.html" title="Class template enable_shared_from_this"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="swap_idp63485808.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="enable_shared_from_this.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="swap_idp56370400.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="enable_shared_from_this.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.to_raw_pointer_idp63491200"></a><div class="titlepage"></div> +<a name="boost.interprocess.to_raw_pointer_idp56375792"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Function template to_raw_pointer</span></h2> <p>boost::interprocess::to_raw_pointer</p> @@ -36,7 +36,7 @@ <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">,</span> <span class="keyword">typename</span> D<span class="special">></span> <a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span><span class="special">::</span><span class="identifier">pointer</span> <span class="identifier">to_raw_pointer</span><span class="special">(</span><a class="link" href="scoped_ptr.html" title="Class template scoped_ptr">scoped_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> p<span class="special">)</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp261610784"></a><h2>Description</h2> +<a name="idp280461696"></a><h2>Description</h2> <p>Returns a copy of the stored pointer Never throws </p> </div> </div> @@ -50,7 +50,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="swap_idp63485808.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="enable_shared_from_this.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="swap_idp56370400.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.smart_ptr.scoped_ptr_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="enable_shared_from_this.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/try_to_lock.html b/doc/html/boost/interprocess/try_to_lock.html index b55e8d3e8e..5dcd6892c0 100644 --- a/doc/html/boost/interprocess/try_to_lock.html +++ b/doc/html/boost/interprocess/try_to_lock.html @@ -34,7 +34,7 @@ </span><span class="keyword">static</span> <span class="keyword">const</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a> try_to_lock<span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp265781008"></a><h2>Description</h2> +<a name="idp284634000"></a><h2>Description</h2> <p>An object indicating that a try_lock() operation must be executed. </p> </div> </div> diff --git a/doc/html/boost/interprocess/unordered_map_index.html b/doc/html/boost/interprocess/unordered_map_index.html index 05a02b619c..4145deb008 100644 --- a/doc/html/boost/interprocess/unordered_map_index.html +++ b/doc/html/boost/interprocess/unordered_map_index.html @@ -38,35 +38,35 @@ <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="unordered_map_index.html#boost.interprocess.unordered_map_indexconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="unordered_map_index.html#idp62470160-bb"><span class="identifier">unordered_map_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="unordered_map_index.html#idp55354752-bb"><span class="identifier">unordered_map_index</span></a><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="unordered_map_index.html#idp62466096-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="unordered_map_index.html#idp62466656-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</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="unordered_map_index.html#idp62468704-bb"><span class="identifier">shrink_to_fit</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="unordered_map_index.html#idp55350688-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="unordered_map_index.html#idp55351248-bb"><span class="identifier">reserve</span></a><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</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="unordered_map_index.html#idp55353296-bb"><span class="identifier">shrink_to_fit</span></a><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="idp255639040"></a><h2>Description</h2> +<a name="idp274489504"></a><h2>Description</h2> <p>Index type based in unordered_map. Just derives from unordered_map and defines the interface needed by managed memory segments </p> <div class="refsect2"> -<a name="idp255639856"></a><h3> +<a name="idp274490320"></a><h3> <a name="boost.interprocess.unordered_map_indexconstruct-copy-destruct"></a><code class="computeroutput">unordered_map_index</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><a name="idp62470160-bb"></a><span class="identifier">unordered_map_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp55354752-bb"></a><span class="identifier">unordered_map_index</span><span class="special">(</span><a class="link" href="segment_manager_base.html" title="Class template segment_manager_base">segment_manager_base</a> <span class="special">*</span> segment_mngr<span class="special">)</span><span class="special">;</span></pre> <p>Constructor. Takes a pointer to the segment manager. Can throw </p> </li></ol></div> </div> <div class="refsect2"> -<a name="idp255647584"></a><h3> -<a name="idp62466096-bb"></a><code class="computeroutput">unordered_map_index</code> public member functions</h3> +<a name="idp274498064"></a><h3> +<a name="idp55350688-bb"></a><code class="computeroutput">unordered_map_index</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62466656-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55351248-bb"></a><span class="identifier">reserve</span><span class="special">(</span><span class="keyword">typename</span> <span class="identifier">segment_manager_base</span><span class="special">::</span><span class="identifier">size_type</span> n<span class="special">)</span><span class="special">;</span></pre> <p>This reserves memory to optimize the insertion of n elements in the index </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp62468704-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp55353296-bb"></a><span class="identifier">shrink_to_fit</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>This tries to free previously allocate unused memory. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/upgradable_lock.html b/doc/html/boost/interprocess/upgradable_lock.html index ee045c9f2f..f98c9c083b 100644 --- a/doc/html/boost/interprocess/upgradable_lock.html +++ b/doc/html/boost/interprocess/upgradable_lock.html @@ -39,123 +39,123 @@ <span class="keyword">typedef</span> <span class="identifier">UpgradableMutex</span> <a name="boost.interprocess.upgradable_lock.mutex_type"></a><span class="identifier">mutex_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="upgradable_lock.html#boost.interprocess.upgradable_lockconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="upgradable_lock.html#idp64694336-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="upgradable_lock.html#idp64695824-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="upgradable_lock.html#idp64697072-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span> - <a class="link" href="upgradable_lock.html#idp64699424-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span> - <a class="link" href="upgradable_lock.html#idp64701808-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span> - <a class="link" href="upgradable_lock.html#idp64704480-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="upgradable_lock.html#idp64707072-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</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> T<span class="special">></span> <a class="link" href="upgradable_lock.html#idp64712176-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html#idp57578928-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="upgradable_lock.html#idp57580416-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html#idp57581664-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html#idp57584016-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html#idp57586400-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html#idp57589072-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html#idp57591664-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</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> T<span class="special">></span> <a class="link" href="upgradable_lock.html#idp57596768-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> <span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a class="link" href="upgradable_lock.html#idp64718448-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> <span class="special">&</span> <a class="link" href="upgradable_lock.html#idp64725312-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="upgradable_lock.html#idp64724496-bb"><span class="special">~</span><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html#idp57603040-bb"><span class="identifier">upgradable_lock</span></a><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span><span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> <span class="special">&</span> <a class="link" href="upgradable_lock.html#idp57609904-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html#idp57609088-bb"><span class="special">~</span><span class="identifier">upgradable_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="upgradable_lock.html#idp64674368-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="upgradable_lock.html#idp64674928-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="upgradable_lock.html#idp64677168-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="upgradable_lock.html#idp64679616-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="upgradable_lock.html#idp64682832-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="upgradable_lock.html#idp64685040-bb"><span class="identifier">owns</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <a class="link" href="upgradable_lock.html#idp64687344-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="upgradable_lock.html#idp64688896-bb"><span class="identifier">mutex</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="upgradable_lock.html#idp64690512-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="upgradable_lock.html#idp64691904-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="upgradable_lock.html#idp57558960-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="upgradable_lock.html#idp57559520-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="upgradable_lock.html#idp57561760-bb"><span class="identifier">try_lock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="upgradable_lock.html#idp57564208-bb"><span class="identifier">timed_lock</span></a><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="upgradable_lock.html#idp57567424-bb"><span class="identifier">unlock</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="upgradable_lock.html#idp57569632-bb"><span class="identifier">owns</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <a class="link" href="upgradable_lock.html#idp57571936-bb"><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="upgradable_lock.html#idp57573488-bb"><span class="identifier">mutex</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mutex_type</span> <span class="special">*</span> <a class="link" href="upgradable_lock.html#idp57575104-bb"><span class="identifier">release</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="upgradable_lock.html#idp57576496-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></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="idp268503824"></a><h2>Description</h2> +<a name="idp287357232"></a><h2>Description</h2> <p><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> is meant to carry out the tasks for read-locking, unlocking, try-read-locking and timed-read-locking (recursive or not) for the Mutex. Additionally the <a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> can transfer ownership to a <a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a> using transfer_lock syntax. The Mutex need not supply all of the functionality. If the client of upgradable_lock<Mutex> does not use functionality which the Mutex does not supply, no harm is done. Mutex ownership can be shared among read_locks, and a single <a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a>. <a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> does not support copy semantics. However <a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> supports ownership transfer from a upgradable_locks or scoped_locks via transfer_lock syntax. </p> <div class="refsect2"> -<a name="idp268510448"></a><h3> +<a name="idp287363920"></a><h3> <a name="boost.interprocess.upgradable_lockconstruct-copy-destruct"></a><code class="computeroutput">upgradable_lock</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64694336-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57578928-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Default constructs a <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code>. Postconditions: owns() == false and mutex() == 0. </p> </li> -<li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp64695824-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre></li> +<li class="listitem"><pre class="literallayout"><span class="keyword">explicit</span> <a name="idp57580416-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">)</span><span class="special">;</span></pre></li> <li class="listitem"> -<pre class="literallayout"><a name="idp64697072-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57581664-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="defer_lock_type.html" title="Struct defer_lock_type">defer_lock_type</a><span class="special">)</span><span class="special">;</span></pre> <p>Postconditions: owns() == false, and mutex() == &m. Notes: The constructor will not take ownership of the mutex. There is no effect required on the referenced mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64699424-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57584016-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="accept_ownership_type.html" title="Struct accept_ownership_type">accept_ownership_type</a><span class="special">)</span><span class="special">;</span></pre> <p>Postconditions: owns() == true, and mutex() == &m. Notes: The constructor will suppose that the mutex is already upgradable locked. There is no effect required on the referenced mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64701808-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57586400-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">)</span><span class="special">;</span></pre> <p>Effects: m.try_lock_upgradable(). Postconditions: mutex() == &m. owns() == the return value of the m.try_lock_upgradable() executed within the constructor. Notes: The constructor will take upgradable-ownership of the mutex if it can do so without waiting. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support try_lock_upgradable, this constructor will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64704480-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57589072-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="identifier">mutex_type</span> <span class="special">&</span> m<span class="special">,</span> <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: m.timed_lock_upgradable(abs_time) Postconditions: mutex() == &m. owns() == the return value of the m.timed_lock_upgradable() executed within the constructor. Notes: The constructor will take upgradable-ownership of the mutex if it can do so within the time specified. Whether or not this constructor handles recursive locking depends upon the mutex. If the mutex_type does not support timed_lock_upgradable, this constructor will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64707072-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57591664-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&&</span> upgr<span class="special">)</span><span class="special">;</span></pre> <p>Effects: No effects on the underlying mutex. Postconditions: mutex() == the value upgr.mutex() had before the construction. upgr.mutex() == 0. owns() == upgr.owns() before the construction. upgr.owns() == false. Notes: If upgr is locked, this constructor will lock this <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code> while unlocking upgr. If upgr is unlocked, then this <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code> will be unlocked as well. Only a moved <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code>'s will match this signature. An non-moved <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code> can be moved with the expression: "boost::move(lock);". This constructor does not alter the state of the mutex, only potentially who owns it. </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a name="idp64712176-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> scop<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> + <a name="idp57596768-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> scop<span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If scop.owns(), m_.unlock_and_lock_upgradable(). Postconditions: mutex() == the value scop.mutex() had before the construction. scop.mutex() == 0. owns() == scop.owns() before the constructor. After the construction, scop.owns() == false. Notes: If scop is locked, this constructor will transfer the exclusive-ownership to an upgradable-ownership of this <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code>. Only a moved <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code>'s will match this signature. An non-moved <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> can be moved with the expression: "boost::move(lock);". </p> </li> <li class="listitem"> <pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> T<span class="special">></span> - <a name="idp64718448-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> shar<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> + <a name="idp57603040-bb"></a><span class="identifier">upgradable_lock</span><span class="special">(</span><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a><span class="special"><</span> <span class="identifier">T</span> <span class="special">></span> <span class="special">&&</span> shar<span class="special">,</span> <a class="link" href="try_to_lock_type.html" title="Struct try_to_lock_type">try_to_lock_type</a><span class="special">,</span> <span class="emphasis"><em><span class="identifier">unspecified</span></em></span> <span class="special">=</span> <span class="number">0</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If shar.owns() then calls try_unlock_sharable_and_lock_upgradable() on the referenced mutex. a)if try_unlock_sharable_and_lock_upgradable() returns true then mutex() obtains the value from shar.release() and owns() is set to true. b)if try_unlock_sharable_and_lock_upgradable() returns false then shar is unaffected and this <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code> construction has the same effects as a default construction. c)Else shar.owns() is false. mutex() obtains the value from shar.release() and owns() is set to false. Notes: This construction will not block. It will try to obtain mutex ownership from shar immediately, while changing the lock type from a "read lock" to an "upgradable lock". If the "read lock" isn't held in the first place, the mutex merely changes type to an unlocked "upgradable lock". If the "read lock" is held, then mutex transfer occurs only if it can do so in a non-blocking manner. </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> <span class="special">&</span> <a name="idp64725312-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> <span class="special">&&</span> upgr<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> <span class="special">&</span> <a name="idp57609904-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a> <span class="special">&&</span> upgr<span class="special">)</span><span class="special">;</span></pre> <p>Effects: If owns(), then unlock_upgradable() is called on mutex(). *this gets the state of upgr and upgr gets set to a default constructed state. Notes: With a recursive mutex it is possible that both this and upgr own the mutex before the assignment. In this case, this will own the mutex after the assignment (and upgr will not), but the mutex's upgradable lock count will be decremented by one. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64724496-bb"></a><span class="special">~</span><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57609088-bb"></a><span class="special">~</span><span class="identifier">upgradable_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: if (owns()) m_->unlock_upgradable(). Notes: The destructor behavior ensures that the mutex lock is not leaked. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp268615088"></a><h3> -<a name="idp64674368-bb"></a><code class="computeroutput">upgradable_lock</code> public member functions</h3> +<a name="idp287468256"></a><h3> +<a name="idp57558960-bb"></a><code class="computeroutput">upgradable_lock</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64674928-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57559520-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls lock_upgradable() on the referenced mutex. Postconditions: owns() == true. Notes: The <code class="computeroutput"><a class="link" href="sharable_lock.html" title="Class template sharable_lock">sharable_lock</a></code> changes from a state of not owning the mutex, to owning the mutex, blocking if necessary. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64677168-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57561760-bb"></a><span class="identifier">try_lock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls try_lock_upgradable() on the referenced mutex. Postconditions: owns() == the value returned from mutex()->try_lock_upgradable(). Notes: The <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code> changes from a state of not owning the mutex, to owning the mutex, but only if blocking was not required. If the mutex_type does not support try_lock_upgradable(), this function will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64679616-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57564208-bb"></a><span class="identifier">timed_lock</span><span class="special">(</span><span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">posix_time</span><span class="special">::</span><span class="identifier">ptime</span> <span class="special">&</span> abs_time<span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or if already locked, throws a lock_exception() exception. Calls timed_lock_upgradable(abs_time) on the referenced mutex. Postconditions: owns() == the value returned from mutex()->timed_lock_upgradable(abs_time). Notes: The <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code> changes from a state of not owning the mutex, to owning the mutex, but only if it can obtain ownership within the specified time. If the mutex_type does not support timed_lock_upgradable(abs_time), this function will fail at compile time if instantiated, but otherwise have no effect. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64682832-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57567424-bb"></a><span class="identifier">unlock</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: If mutex() == 0 or if not locked, throws a lock_exception() exception. Calls unlock_upgradable() on the referenced mutex. Postconditions: owns() == false. Notes: The <code class="computeroutput"><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a></code> changes from a state of owning the mutex, to not owning the mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp64685040-bb"></a><span class="identifier">owns</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp57569632-bb"></a><span class="identifier">owns</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Effects: Returns true if this <code class="computeroutput"><a class="link" href="scoped_lock.html" title="Class template scoped_lock">scoped_lock</a></code> has acquired the referenced mutex. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64687344-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57571936-bb"></a><span class="keyword">operator</span> <span class="identifier">unspecified_bool_type</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Conversion to bool. Returns owns(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp64688896-bb"></a><span class="identifier">mutex</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp57573488-bb"></a><span class="identifier">mutex</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp64690512-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mutex_type</span> <span class="special">*</span> <a name="idp57575104-bb"></a><span class="identifier">release</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Returns a pointer to the referenced mutex, or 0 if there is no mutex to reference. Postconditions: mutex() == 0 and owns() == false. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64691904-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57576496-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="upgradable_lock.html" title="Class template upgradable_lock">upgradable_lock</a><span class="special"><</span> <span class="identifier">mutex_type</span> <span class="special">></span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Effects: Swaps state with moved lock. Throws: Nothing. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/weak_ptr.html b/doc/html/boost/interprocess/weak_ptr.html index 6a51b042c0..268e23cdda 100644 --- a/doc/html/boost/interprocess/weak_ptr.html +++ b/doc/html/boost/interprocess/weak_ptr.html @@ -40,55 +40,55 @@ <span class="keyword">typedef</span> <span class="identifier">T</span> <a name="boost.interprocess.weak_ptr.value_type"></a><span class="identifier">value_type</span><span class="special">;</span> <span class="comment">// <a class="link" href="weak_ptr.html#boost.interprocess.weak_ptrconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="weak_ptr.html#idp63682288-bb"><span class="identifier">weak_ptr</span></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> Y<span class="special">></span> <a class="link" href="weak_ptr.html#idp63683760-bb"><span class="identifier">weak_ptr</span></a><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</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> Y<span class="special">></span> <a class="link" href="weak_ptr.html#idp63688480-bb"><span class="identifier">weak_ptr</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</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> Y<span class="special">></span> <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> <span class="special">&</span> <a class="link" href="weak_ptr.html#idp63693200-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</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> Y<span class="special">></span> <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> <span class="special">&</span> <a class="link" href="weak_ptr.html#idp63697024-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="weak_ptr.html#idp56566880-bb"><span class="identifier">weak_ptr</span></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> Y<span class="special">></span> <a class="link" href="weak_ptr.html#idp56568352-bb"><span class="identifier">weak_ptr</span></a><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</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> Y<span class="special">></span> <a class="link" href="weak_ptr.html#idp56573072-bb"><span class="identifier">weak_ptr</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</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> Y<span class="special">></span> <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> <span class="special">&</span> <a class="link" href="weak_ptr.html#idp56577792-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</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> Y<span class="special">></span> <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> <span class="special">&</span> <a class="link" href="weak_ptr.html#idp56581616-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="weak_ptr.html#idp63670656-bb">public member functions</a></span> - <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a class="link" href="weak_ptr.html#idp63671216-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">long</span> <a class="link" href="weak_ptr.html#idp63673376-bb"><span class="identifier">use_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">bool</span> <a class="link" href="weak_ptr.html#idp63676384-bb"><span class="identifier">expired</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="weak_ptr.html#idp63678544-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">void</span> <a class="link" href="weak_ptr.html#idp63679840-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">this_type</span> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="weak_ptr.html#idp56555248-bb">public member functions</a></span> + <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a class="link" href="weak_ptr.html#idp56555808-bb"><span class="identifier">lock</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">long</span> <a class="link" href="weak_ptr.html#idp56557968-bb"><span class="identifier">use_count</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">bool</span> <a class="link" href="weak_ptr.html#idp56560976-bb"><span class="identifier">expired</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="weak_ptr.html#idp56563136-bb"><span class="identifier">reset</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">void</span> <a class="link" href="weak_ptr.html#idp56564432-bb"><span class="identifier">swap</span></a><span class="special">(</span><span class="identifier">this_type</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="idp262731776"></a><h2>Description</h2> +<a name="idp281582944"></a><h2>Description</h2> <p>The <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> class template stores a "weak reference" to an object that's already managed by a <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a>. To access the object, a <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> can be converted to a <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> using the <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> constructor or the member function lock. When the last <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> to the object goes away and the object is deleted, the attempt to obtain a <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a> from the <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> instances that refer to the deleted object will fail: the constructor will throw an exception of type bad_weak_ptr, and weak_ptr::lock will return an empty <a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a>.</p> <p>Every <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> meets the CopyConstructible and Assignable requirements of the C++ Standard Library, and so can be used in standard library containers. Comparison operators are supplied so that <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> works with the standard library's associative containers.</p> <p><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> operations never throw exceptions.</p> <p>The class template is parameterized on T, the type of the object pointed to. </p> <div class="refsect2"> -<a name="idp262744144"></a><h3> +<a name="idp281595312"></a><h3> <a name="boost.interprocess.weak_ptrconstruct-copy-destruct"></a><code class="computeroutput">weak_ptr</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp63682288-bb"></a><span class="identifier">weak_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp56566880-bb"></a><span class="identifier">weak_ptr</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Constructs an empty <code class="computeroutput"><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a></code>. Postconditions: use_count() == 0. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> <a name="idp63683760-bb"></a><span class="identifier">weak_ptr</span><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> <a name="idp56568352-bb"></a><span class="identifier">weak_ptr</span><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> <p>Effects: If r is empty, constructs an empty <code class="computeroutput"><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a></code>; otherwise, constructs a <code class="computeroutput"><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a></code> that shares ownership with r as if by storing a copy of the pointer stored in r.</p> <p>Postconditions: use_count() == r.use_count().</p> <p>Throws: nothing. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> <a name="idp63688480-bb"></a><span class="identifier">weak_ptr</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> <a name="idp56573072-bb"></a><span class="identifier">weak_ptr</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> <p>Effects: If r is empty, constructs an empty <code class="computeroutput"><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a></code>; otherwise, constructs a <code class="computeroutput"><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a></code> that shares ownership with r as if by storing a copy of the pointer stored in r.</p> <p>Postconditions: use_count() == r.use_count().</p> <p>Throws: nothing. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> <span class="special">&</span> <a name="idp63693200-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> <span class="special">&</span> <a name="idp56577792-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> <p>Effects: Equivalent to weak_ptr(r).swap(*this).</p> <p>Throws: nothing.</p> <p>Notes: The implementation is free to meet the effects (and the implied guarantees) via different means, without creating a temporary. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> <span class="special">&</span> <a name="idp63697024-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> Y<span class="special">></span> <a class="link" href="weak_ptr.html" title="Class template weak_ptr">weak_ptr</a> <span class="special">&</span> <a name="idp56581616-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">Y</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <span class="keyword">const</span> <span class="special">&</span> r<span class="special">)</span><span class="special">;</span></pre> <p>Effects: Equivalent to weak_ptr(r).swap(*this).</p> <p>Throws: nothing.</p> <p>Notes: The implementation is free to meet the effects (and the implied guarantees) via different means, without creating a temporary. </p> @@ -96,32 +96,32 @@ </ol></div> </div> <div class="refsect2"> -<a name="idp262815200"></a><h3> -<a name="idp63670656-bb"></a><code class="computeroutput">weak_ptr</code> public member functions</h3> +<a name="idp281666320"></a><h3> +<a name="idp56555248-bb"></a><code class="computeroutput">weak_ptr</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a name="idp63671216-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a><span class="special"><</span> <span class="identifier">T</span><span class="special">,</span> <span class="identifier">A</span><span class="special">,</span> <span class="identifier">D</span> <span class="special">></span> <a name="idp56555808-bb"></a><span class="identifier">lock</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns: expired()? shared_ptr<T>(): shared_ptr<T>(*this).</p> <p>Throws: nothing. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">long</span> <a name="idp63673376-bb"></a><span class="identifier">use_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">long</span> <a name="idp56557968-bb"></a><span class="identifier">use_count</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns: 0 if *this is empty; otherwise, the number of <code class="computeroutput"><a class="link" href="shared_ptr.html" title="Class template shared_ptr">shared_ptr</a></code> objects that share ownership with *this.</p> <p>Throws: nothing.</p> <p>Notes: use_count() is not necessarily efficient. Use only for debugging and testing purposes, not for production code. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">bool</span> <a name="idp63676384-bb"></a><span class="identifier">expired</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">bool</span> <a name="idp56560976-bb"></a><span class="identifier">expired</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns: Returns: use_count() == 0.</p> <p>Throws: nothing.</p> <p>Notes: expired() may be faster than use_count(). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63678544-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56563136-bb"></a><span class="identifier">reset</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Effects: Equivalent to: weak_ptr().swap(*this). </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp63679840-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">this_type</span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp56564432-bb"></a><span class="identifier">swap</span><span class="special">(</span><span class="identifier">this_type</span> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre> <p>Effects: Exchanges the contents of the two smart pointers.</p> <p>Throws: nothing. </p> </li> diff --git a/doc/html/boost/interprocess/wfixed_managed_idp62766576.html b/doc/html/boost/interprocess/wfixed_managed_idp55651168.html index 925af2dae1..7fcd69ac80 100644 --- a/doc/html/boost/interprocess/wfixed_managed_idp62766576.html +++ b/doc/html/boost/interprocess/wfixed_managed_idp55651168.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_hpp" title="Header <boost/interprocess/managed_shared_memory.hpp>"> -<link rel="prev" href="fixed_managed__idp62762848.html" title="Type definition fixed_managed_shared_memory"> -<link rel="next" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory"> +<link rel="prev" href="fixed_managed__idp55647440.html" title="Type definition fixed_managed_shared_memory"> +<link rel="next" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="fixed_managed__idp62762848.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="basic_managed__idp62772528.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="fixed_managed__idp55647440.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="basic_managed__idp55657120.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.wfixed_managed_idp62766576"></a><div class="titlepage"></div> +<a name="boost.interprocess.wfixed_managed_idp55651168"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Type definition wfixed_managed_shared_memory</span></h2> <p>wfixed_managed_shared_memory</p> @@ -33,10 +33,10 @@ <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.managed_shared_memory_hpp" title="Header <boost/interprocess/managed_shared_memory.hpp>">boost/interprocess/managed_shared_memory.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wfixed_managed_shared_memory</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a><span class="special">,</span> <span class="keyword">void</span> <span class="special">*</span> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wfixed_managed_shared_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257134160"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> of narrow characters to be placed in a fixed address </p> +<a name="idp275984224"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> of narrow characters to be placed in a fixed address </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="fixed_managed__idp62762848.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="basic_managed__idp62772528.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="fixed_managed__idp55647440.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="basic_managed__idp55657120.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/windows_shared_memory.html b/doc/html/boost/interprocess/windows_shared_memory.html index 58a620c263..c8951f8518 100644 --- a/doc/html/boost/interprocess/windows_shared_memory.html +++ b/doc/html/boost/interprocess/windows_shared_memory.html @@ -36,81 +36,81 @@ <span class="keyword">class</span> <a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="windows_shared_memory.html#boost.interprocess.windows_shared_memoryconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="windows_shared_memory.html#idp64743904-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="windows_shared_memory.html#idp64745392-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> + <a class="link" href="windows_shared_memory.html#idp57628496-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="windows_shared_memory.html#idp57629984-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</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="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="windows_shared_memory.html#idp64751120-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> + <a class="link" href="windows_shared_memory.html#idp57635712-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</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="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="windows_shared_memory.html#idp64756896-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="windows_shared_memory.html#idp64759920-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&</span> <a class="link" href="windows_shared_memory.html#idp64761728-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="windows_shared_memory.html#idp64764096-bb"><span class="special">~</span><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="windows_shared_memory.html#idp57641488-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">mode_t</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="windows_shared_memory.html#idp57644512-bb"><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&</span> <a class="link" href="windows_shared_memory.html#idp57646320-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="windows_shared_memory.html#idp57648688-bb"><span class="special">~</span><span class="identifier">windows_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="windows_shared_memory.html#idp64735136-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="windows_shared_memory.html#idp64735696-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="windows_shared_memory.html#idp64737840-bb"><span class="identifier">get_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mode_t</span> <a class="link" href="windows_shared_memory.html#idp64739264-bb"><span class="identifier">get_mode</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mapping_handle_t</span> <a class="link" href="windows_shared_memory.html#idp64740672-bb"><span class="identifier">get_mapping_handle</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">offset_t</span> <a class="link" href="windows_shared_memory.html#idp64742112-bb"><span class="identifier">get_size</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="windows_shared_memory.html#idp57619728-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="windows_shared_memory.html#idp57620288-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a class="link" href="windows_shared_memory.html#idp57622432-bb"><span class="identifier">get_name</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mode_t</span> <a class="link" href="windows_shared_memory.html#idp57623856-bb"><span class="identifier">get_mode</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mapping_handle_t</span> <a class="link" href="windows_shared_memory.html#idp57625264-bb"><span class="identifier">get_mapping_handle</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">offset_t</span> <a class="link" href="windows_shared_memory.html#idp57626704-bb"><span class="identifier">get_size</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp268777600"></a><h2>Description</h2> +<a name="idp287630768"></a><h2>Description</h2> <p>A class that wraps the native Windows shared memory that is implemented as a file mapping of the paging file. Unlike <a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a>, <a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> has no kernel persistence and the shared memory is destroyed when all processes destroy all their <a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> objects and mapped regions for the same shared memory or the processes end/crash.</p> <p>Warning: Windows native shared memory and interprocess portable shared memory (<a class="link" href="shared_memory_object.html" title="Class shared_memory_object">boost::interprocess::shared_memory_object</a>) can't communicate between them. </p> <div class="refsect2"> -<a name="idp268782432"></a><h3> +<a name="idp287635600"></a><h3> <a name="boost.interprocess.windows_shared_memoryconstruct-copy-destruct"></a><code class="computeroutput">windows_shared_memory</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64743904-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57628496-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructor. Represents an empty <code class="computeroutput"><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64745392-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> +<pre class="literallayout"><a name="idp57629984-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a new native shared memory with name "name" and at least size "size", with the access mode "mode". If the file previously exists, throws an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64751120-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> +<pre class="literallayout"><a name="idp57635712-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Tries to create a shared memory object with name "name" and at least size "size", with the access mode "mode". If the file previously exists, it tries to open it with mode "mode". Otherwise throws an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64756896-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57641488-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> name<span class="special">,</span> <span class="identifier">mode_t</span> mode<span class="special">)</span><span class="special">;</span></pre> <p>Tries to open a shared memory object with name "name", with the access mode "mode". If the file does not previously exist, it throws an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64759920-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57644512-bb"></a><span class="identifier">windows_shared_memory</span><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s shared memory object to *this. After the call, "moved" does not represent any shared memory object. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&</span> <a name="idp64761728-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&</span> <a name="idp57646320-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s shared memory to *this. After the call, "moved" does not represent any shared memory. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64764096-bb"></a><span class="special">~</span><span class="identifier">windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57648688-bb"></a><span class="special">~</span><span class="identifier">windows_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this. All mapped regions are still valid after destruction. When all mapped regions and <code class="computeroutput"><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a></code> objects referring the shared memory are destroyed, the operating system will destroy the shared memory. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp268851296"></a><h3> -<a name="idp64735136-bb"></a><code class="computeroutput">windows_shared_memory</code> public member functions</h3> +<a name="idp287704192"></a><h3> +<a name="idp57619728-bb"></a><code class="computeroutput">windows_shared_memory</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64735696-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Swaps to shared_memory_objects. Does not throw. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57620288-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="windows_shared_memory.html" title="Class windows_shared_memory">windows_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Swaps to shared_memory_objects. Does not throw. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp64737840-bb"></a><span class="identifier">get_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the name of the shared memory. </li> +<pre class="literallayout"><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> <a name="idp57622432-bb"></a><span class="identifier">get_name</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the name of the shared memory. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mode_t</span> <a name="idp64739264-bb"></a><span class="identifier">get_mode</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns access mode. </li> +<pre class="literallayout"><span class="identifier">mode_t</span> <a name="idp57623856-bb"></a><span class="identifier">get_mode</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns access mode. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idp64740672-bb"></a><span class="identifier">get_mapping_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the mapping handle. Never throws. </li> +<pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idp57625264-bb"></a><span class="identifier">get_mapping_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the mapping handle. Never throws. </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">offset_t</span> <a name="idp64742112-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">offset_t</span> <a name="idp57626704-bb"></a><span class="identifier">get_size</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the size of the windows shared memory. It will be a 4K rounded size of the "size" passed in the constructor. </p> </li> </ol></div> diff --git a/doc/html/boost/interprocess/wmanaged_external_buffer.html b/doc/html/boost/interprocess/wmanaged_external_buffer.html index ea4a262c14..d7982ae8b9 100644 --- a/doc/html/boost/interprocess/wmanaged_external_buffer.html +++ b/doc/html/boost/interprocess/wmanaged_external_buffer.html @@ -33,10 +33,10 @@ <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.managed_external_buffer_hpp" title="Header <boost/interprocess/managed_external_buffer.hpp>">boost/interprocess/managed_external_buffer.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="null_mutex_family.html" title="Struct null_mutex_family">null_mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_external_buffer</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="null_mutex_family.html" title="Struct null_mutex_family">null_mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_external_buffer</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp256268944"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62606272.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> of wide characters </p> +<a name="idp275119616"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55490864.html" title="Class template basic_managed_external_buffer">basic_managed_external_buffer</a> of wide characters </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> diff --git a/doc/html/boost/interprocess/wmanaged_heap_memory.html b/doc/html/boost/interprocess/wmanaged_heap_memory.html index 8a26651f17..2aed34da5a 100644 --- a/doc/html/boost/interprocess/wmanaged_heap_memory.html +++ b/doc/html/boost/interprocess/wmanaged_heap_memory.html @@ -35,7 +35,7 @@ </span> <span class="keyword">typedef</span> <a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="null_mutex_family.html" title="Struct null_mutex_family">null_mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_heap_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp256435440"></a><h2>Description</h2> +<a name="idp275285872"></a><h2>Description</h2> <p>Typedef for a default <a class="link" href="basic_managed_heap_memory.html" title="Class template basic_managed_heap_memory">basic_managed_heap_memory</a> of wide characters </p> </div> </div> diff --git a/doc/html/boost/interprocess/wmanaged_mapped_file.html b/doc/html/boost/interprocess/wmanaged_mapped_file.html index 9c64167104..d31d15d0e0 100644 --- a/doc/html/boost/interprocess/wmanaged_mapped_file.html +++ b/doc/html/boost/interprocess/wmanaged_mapped_file.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_mapped_file_hpp" title="Header <boost/interprocess/managed_mapped_file.hpp>"> <link rel="prev" href="managed_mapped_file.html" title="Type definition managed_mapped_file"> -<link rel="next" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory"> +<link rel="next" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="managed_mapped_file.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_mapped_file_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="basic_managed__idp62714784.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="managed_mapped_file.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_mapped_file_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="basic_managed__idp55599376.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.wmanaged_mapped_file"></a><div class="titlepage"></div> @@ -35,7 +35,7 @@ </span> <span class="keyword">typedef</span> <a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_mapped_file</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp256766240"></a><h2>Description</h2> +<a name="idp275616448"></a><h2>Description</h2> <p>Typedef for a default <a class="link" href="basic_managed_mapped_file.html" title="Class template basic_managed_mapped_file">basic_managed_mapped_file</a> of wide characters </p> </div> </div> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="managed_mapped_file.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_mapped_file_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="basic_managed__idp62714784.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="managed_mapped_file.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_mapped_file_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="basic_managed__idp55599376.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/wmanaged_shared_memory.html b/doc/html/boost/interprocess/wmanaged_shared_memory.html index 9f360f52ba..2ee87a3978 100644 --- a/doc/html/boost/interprocess/wmanaged_shared_memory.html +++ b/doc/html/boost/interprocess/wmanaged_shared_memory.html @@ -8,7 +8,7 @@ <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_hpp" title="Header <boost/interprocess/managed_shared_memory.hpp>"> <link rel="prev" href="managed_shared_memory.html" title="Type definition managed_shared_memory"> -<link rel="next" href="fixed_managed__idp62762848.html" title="Type definition fixed_managed_shared_memory"> +<link rel="next" href="fixed_managed__idp55647440.html" title="Type definition fixed_managed_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,7 +21,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="managed_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="fixed_managed__idp62762848.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="managed_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="fixed_managed__idp55647440.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> <a name="boost.interprocess.wmanaged_shared_memory"></a><div class="titlepage"></div> @@ -33,10 +33,10 @@ <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.managed_shared_memory_hpp" title="Header <boost/interprocess/managed_shared_memory.hpp>">boost/interprocess/managed_shared_memory.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_shared_memory</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_shared_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257100864"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62714784.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> of wide characters </p> +<a name="idp275950928"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55599376.html" title="Class template basic_managed_shared_memory">basic_managed_shared_memory</a> of wide characters </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="managed_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="fixed_managed__idp62762848.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="managed_shared_memory.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_shared_memory_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="fixed_managed__idp55647440.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/wmanaged_windo_idp62815312.html b/doc/html/boost/interprocess/wmanaged_windo_idp55699904.html index f29b9caf2f..c3609e748e 100644 --- a/doc/html/boost/interprocess/wmanaged_windo_idp62815312.html +++ b/doc/html/boost/interprocess/wmanaged_windo_idp55699904.html @@ -7,8 +7,8 @@ <meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> <link rel="up" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_hpp" title="Header <boost/interprocess/managed_windows_shared_memory.hpp>"> -<link rel="prev" href="managed_window_idp62811600.html" title="Type definition managed_windows_shared_memory"> -<link rel="next" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory"> +<link rel="prev" href="managed_window_idp55696192.html" title="Type definition managed_windows_shared_memory"> +<link rel="next" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table cellpadding="2" width="100%"><tr> @@ -21,10 +21,10 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="managed_window_idp62811600.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="basic_managed__idp62821248.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="managed_window_idp55696192.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="basic_managed__idp55705840.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> <div class="refentry"> -<a name="boost.interprocess.wmanaged_windo_idp62815312"></a><div class="titlepage"></div> +<a name="boost.interprocess.wmanaged_windo_idp55699904"></a><div class="titlepage"></div> <div class="refnamediv"> <h2><span class="refentrytitle">Type definition wmanaged_windows_shared_memory</span></h2> <p>wmanaged_windows_shared_memory</p> @@ -33,10 +33,10 @@ <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.managed_windows_shared_memory_hpp" title="Header <boost/interprocess/managed_windows_shared_memory.hpp>">boost/interprocess/managed_windows_shared_memory.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_windows_shared_memory</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_windows_shared_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257421536"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62772528.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> of wide characters </p> +<a name="idp276271936"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55657120.html" title="Class template basic_managed_windows_shared_memory">basic_managed_windows_shared_memory</a> of wide characters </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> @@ -49,7 +49,7 @@ </tr></table> <hr> <div class="spirit-nav"> -<a accesskey="p" href="managed_window_idp62811600.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="basic_managed__idp62821248.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> +<a accesskey="p" href="managed_window_idp55696192.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../interprocess/indexes_reference.html#header.boost.interprocess.managed_windows_shared_memory_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="basic_managed__idp55705840.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a> </div> </body> </html> diff --git a/doc/html/boost/interprocess/wmanaged_xsi_shared_memory.html b/doc/html/boost/interprocess/wmanaged_xsi_shared_memory.html index baf90deee8..ea3e6f3a69 100644 --- a/doc/html/boost/interprocess/wmanaged_xsi_shared_memory.html +++ b/doc/html/boost/interprocess/wmanaged_xsi_shared_memory.html @@ -33,10 +33,10 @@ <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.managed_xsi_shared_memory_hpp" title="Header <boost/interprocess/managed_xsi_shared_memory.hpp>">boost/interprocess/managed_xsi_shared_memory.hpp</a>> </span> -<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_xsi_shared_memory</span><span class="special">;</span></pre></div> +<span class="keyword">typedef</span> <a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a><span class="special"><</span> <span class="keyword">wchar_t</span><span class="special">,</span><a class="link" href="rbtree_best_fit.html" title="Class template rbtree_best_fit">rbtree_best_fit</a><span class="special"><</span> <a class="link" href="mutex_family.html" title="Struct mutex_family">mutex_family</a> <span class="special">></span><span class="special">,</span><a class="link" href="iset_index.html" title="Class template iset_index">iset_index</a> <span class="special">></span> <span class="identifier">wmanaged_xsi_shared_memory</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp257711968"></a><h2>Description</h2> -<p>Typedef for a default <a class="link" href="basic_managed__idp62821248.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> of wide characters </p> +<a name="idp276561856"></a><h2>Description</h2> +<p>Typedef for a default <a class="link" href="basic_managed__idp55705840.html" title="Class template basic_managed_xsi_shared_memory">basic_managed_xsi_shared_memory</a> of wide characters </p> </div> </div> <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> diff --git a/doc/html/boost/interprocess/xsi_key.html b/doc/html/boost/interprocess/xsi_key.html index 6735e0070b..5a0281c7f1 100644 --- a/doc/html/boost/interprocess/xsi_key.html +++ b/doc/html/boost/interprocess/xsi_key.html @@ -36,39 +36,39 @@ <span class="keyword">class</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="xsi_key.html#boost.interprocess.xsi_keyconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="xsi_key.html#idp64771552-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">explicit</span> <a class="link" href="xsi_key.html#idp64773024-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="identifier">key_t</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="xsi_key.html#idp64774640-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="xsi_key.html#idp57656144-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">explicit</span> <a class="link" href="xsi_key.html#idp57657616-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="identifier">key_t</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="xsi_key.html#idp57659232-bb"><span class="identifier">xsi_key</span></a><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span><span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="xsi_key.html#idp64769408-bb">public member functions</a></span> - <span class="identifier">key_t</span> <a class="link" href="xsi_key.html#idp64769968-bb"><span class="identifier">get_key</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="xsi_key.html#idp57654000-bb">public member functions</a></span> + <span class="identifier">key_t</span> <a class="link" href="xsi_key.html#idp57654560-bb"><span class="identifier">get_key</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp268921488"></a><h2>Description</h2> +<a name="idp287774432"></a><h2>Description</h2> <p>A class that wraps XSI (System V) key_t type. This type calculates key_t from path and id using ftok, sets key to a specified value, or sets key to IPC_PRIVATE using the default constructor. </p> <div class="refsect2"> -<a name="idp268922368"></a><h3> +<a name="idp287775312"></a><h3> <a name="boost.interprocess.xsi_keyconstruct-copy-destruct"></a><code class="computeroutput">xsi_key</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64771552-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57656144-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructor. Represents a private <code class="computeroutput"><a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp64773024-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="identifier">key_t</span> key<span class="special">)</span><span class="special">;</span></pre>Creates a new XSI key using a specified value. Constructor is explicit to avoid ambiguity with shmid. </li> +<pre class="literallayout"><span class="keyword">explicit</span> <a name="idp57657616-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="identifier">key_t</span> key<span class="special">)</span><span class="special">;</span></pre>Creates a new XSI key using a specified value. Constructor is explicit to avoid ambiguity with shmid. </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64774640-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> path<span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span> id<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57659232-bb"></a><span class="identifier">xsi_key</span><span class="special">(</span><span class="keyword">const</span> <span class="keyword">char</span> <span class="special">*</span> path<span class="special">,</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">uint8_t</span> id<span class="special">)</span><span class="special">;</span></pre> <p>Creates a new XSI shared memory with a key obtained from a call to ftok (with path "path" and id "id"), of size "size" and permissions "perm". If the shared memory previously exists, throws an error. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp268943664"></a><h3> -<a name="idp64769408-bb"></a><code class="computeroutput">xsi_key</code> public member functions</h3> +<a name="idp287796608"></a><h3> +<a name="idp57654000-bb"></a><code class="computeroutput">xsi_key</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="identifier">key_t</span> <a name="idp64769968-bb"></a><span class="identifier">get_key</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the internal key_t value. </li></ol></div> +<pre class="literallayout"><span class="identifier">key_t</span> <a name="idp57654560-bb"></a><span class="identifier">get_key</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre>Returns the internal key_t value. </li></ol></div> </div> </div> </div> diff --git a/doc/html/boost/interprocess/xsi_shared_memory.html b/doc/html/boost/interprocess/xsi_shared_memory.html index 20b8fdc0fb..c6e97a01da 100644 --- a/doc/html/boost/interprocess/xsi_shared_memory.html +++ b/doc/html/boost/interprocess/xsi_shared_memory.html @@ -36,92 +36,92 @@ <span class="keyword">class</span> <a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">{</span> <span class="keyword">public</span><span class="special">:</span> <span class="comment">// <a class="link" href="xsi_shared_memory.html#boost.interprocess.xsi_shared_memoryconstruct-copy-destruct">construct/copy/destruct</a></span> - <a class="link" href="xsi_shared_memory.html#idp64789888-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="xsi_shared_memory.html#idp64791360-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="xsi_shared_memory.html#idp64793712-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> + <a class="link" href="xsi_shared_memory.html#idp57674480-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="xsi_shared_memory.html#idp57675952-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="xsi_shared_memory.html#idp57678304-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</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="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="xsi_shared_memory.html#idp64799184-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span><span class="special">,</span> + <a class="link" href="xsi_shared_memory.html#idp57683776-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</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="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="xsi_shared_memory.html#idp64804672-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="xsi_shared_memory.html#idp64807440-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span> <a class="link" href="xsi_shared_memory.html#idp64809248-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> - <a class="link" href="xsi_shared_memory.html#idp64811616-bb"><span class="special">~</span><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="xsi_shared_memory.html#idp57689264-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="xsi_shared_memory.html#idp57692032-bb"><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span> <a class="link" href="xsi_shared_memory.html#idp57693840-bb"><span class="keyword">operator</span><span class="special">=</span></a><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span><span class="special">)</span><span class="special">;</span> + <a class="link" href="xsi_shared_memory.html#idp57696208-bb"><span class="special">~</span><span class="identifier">xsi_shared_memory</span></a><span class="special">(</span><span class="special">)</span><span class="special">;</span> - <span class="comment">// <a class="link" href="xsi_shared_memory.html#idp64783872-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="xsi_shared_memory.html#idp64784432-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> - <span class="keyword">int</span> <a class="link" href="xsi_shared_memory.html#idp64786576-bb"><span class="identifier">get_shmid</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> - <span class="identifier">mapping_handle_t</span> <a class="link" href="xsi_shared_memory.html#idp64788160-bb"><span class="identifier">get_mapping_handle</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="xsi_shared_memory.html#idp57668464-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="xsi_shared_memory.html#idp57669024-bb"><span class="identifier">swap</span></a><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span><span class="special">)</span><span class="special">;</span> + <span class="keyword">int</span> <a class="link" href="xsi_shared_memory.html#idp57671168-bb"><span class="identifier">get_shmid</span></a><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span> + <span class="identifier">mapping_handle_t</span> <a class="link" href="xsi_shared_memory.html#idp57672752-bb"><span class="identifier">get_mapping_handle</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="xsi_shared_memory.html#idp64812432-bb">public static functions</a></span> - <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="xsi_shared_memory.html#idp64812992-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> + <span class="comment">// <a class="link" href="xsi_shared_memory.html#idp57697024-bb">public static functions</a></span> + <span class="keyword">static</span> <span class="keyword">bool</span> <a class="link" href="xsi_shared_memory.html#idp57697584-bb"><span class="identifier">remove</span></a><span class="special">(</span><span class="keyword">int</span><span class="special">)</span><span class="special">;</span> <span class="special">}</span><span class="special">;</span></pre></div> <div class="refsect1"> -<a name="idp269048352"></a><h2>Description</h2> +<a name="idp287901456"></a><h2>Description</h2> <p>A class that wraps XSI (System V) shared memory. Unlike <a class="link" href="shared_memory_object.html" title="Class shared_memory_object">shared_memory_object</a>, <a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> needs a valid <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> to identify a shared memory object.</p> <p>Warning: XSI shared memory and interprocess portable shared memory (<a class="link" href="shared_memory_object.html" title="Class shared_memory_object">boost::interprocess::shared_memory_object</a>) can't communicate between them. </p> <div class="refsect2"> -<a name="idp269052928"></a><h3> +<a name="idp287906032"></a><h3> <a name="boost.interprocess.xsi_shared_memoryconstruct-copy-destruct"></a><code class="computeroutput">xsi_shared_memory</code> public construct/copy/destruct</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><a name="idp64789888-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57674480-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Default constructor. Represents an empty <code class="computeroutput"><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a></code>. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64791360-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">int</span> shmid<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57675952-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">int</span> shmid<span class="special">)</span><span class="special">;</span></pre> <p>Initializes *this with a shmid previously obtained (possibly from another process) This lower-level initializer allows shared memory mapping without having a key. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64793712-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> +<pre class="literallayout"><a name="idp57678304-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="create_only_t.html" title="Struct create_only_t">create_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Creates a new XSI shared memory from 'key', with size "size" and permissions "perm". If the shared memory previously exists, throws an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64799184-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> +<pre class="literallayout"><a name="idp57683776-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_or_create_t.html" title="Struct open_or_create_t">open_or_create_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">,</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> size<span class="special">,</span> <span class="keyword">const</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a> <span class="special">&</span> perm <span class="special">=</span> <a class="link" href="permissions.html" title="Class permissions">permissions</a><span class="special">(</span><span class="special">)</span><span class="special">)</span><span class="special">;</span></pre> <p>Opens an existing shared memory with identifier 'key' or creates a new XSI shared memory from identifier 'key', with size "size" and permissions "perm". </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64804672-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57689264-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="open_only_t.html" title="Struct open_only_t">open_only_t</a><span class="special">,</span> <span class="keyword">const</span> <a class="link" href="xsi_key.html" title="Class xsi_key">xsi_key</a> <span class="special">&</span> key<span class="special">)</span><span class="special">;</span></pre> <p>Tries to open a XSI shared memory with identifier 'key' If the shared memory does not previously exist, it throws an error. </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64807440-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57692032-bb"></a><span class="identifier">xsi_shared_memory</span><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s shared memory object to *this. After the call, "moved" does not represent any shared memory object. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span> <a name="idp64809248-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span> <a name="idp57693840-bb"></a><span class="keyword">operator</span><span class="special">=</span><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&&</span> moved<span class="special">)</span><span class="special">;</span></pre> <p>Moves the ownership of "moved"'s shared memory to *this. After the call, "moved" does not represent any shared memory. Does not throw </p> </li> <li class="listitem"> -<pre class="literallayout"><a name="idp64811616-bb"></a><span class="special">~</span><span class="identifier">xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><a name="idp57696208-bb"></a><span class="special">~</span><span class="identifier">xsi_shared_memory</span><span class="special">(</span><span class="special">)</span><span class="special">;</span></pre> <p>Destroys *this. The shared memory won't be destroyed, just this connection to it. Use remove() to destroy the shared memory. </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp269122464"></a><h3> -<a name="idp64783872-bb"></a><code class="computeroutput">xsi_shared_memory</code> public member functions</h3> +<a name="idp287975568"></a><h3> +<a name="idp57668464-bb"></a><code class="computeroutput">xsi_shared_memory</code> public member functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"> <li class="listitem"> -<pre class="literallayout"><span class="keyword">void</span> <a name="idp64784432-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Swaps two xsi_shared_memorys. Does not throw. </li> +<pre class="literallayout"><span class="keyword">void</span> <a name="idp57669024-bb"></a><span class="identifier">swap</span><span class="special">(</span><a class="link" href="xsi_shared_memory.html" title="Class xsi_shared_memory">xsi_shared_memory</a> <span class="special">&</span> other<span class="special">)</span><span class="special">;</span></pre>Swaps two xsi_shared_memorys. Does not throw. </li> <li class="listitem"> -<pre class="literallayout"><span class="keyword">int</span> <a name="idp64786576-bb"></a><span class="identifier">get_shmid</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">int</span> <a name="idp57671168-bb"></a><span class="identifier">get_shmid</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the shared memory ID that identifies the shared memory </p> </li> <li class="listitem"> -<pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idp64788160-bb"></a><span class="identifier">get_mapping_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="identifier">mapping_handle_t</span> <a name="idp57672752-bb"></a><span class="identifier">get_mapping_handle</span><span class="special">(</span><span class="special">)</span> <span class="keyword">const</span><span class="special">;</span></pre> <p>Returns the mapping handle. Never throws </p> </li> </ol></div> </div> <div class="refsect2"> -<a name="idp269141184"></a><h3> -<a name="idp64812432-bb"></a><code class="computeroutput">xsi_shared_memory</code> public static functions</h3> +<a name="idp287994288"></a><h3> +<a name="idp57697024-bb"></a><code class="computeroutput">xsi_shared_memory</code> public static functions</h3> <div class="orderedlist"><ol class="orderedlist" type="1"><li class="listitem"> -<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp64812992-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">int</span> shmid<span class="special">)</span><span class="special">;</span></pre> +<pre class="literallayout"><span class="keyword">static</span> <span class="keyword">bool</span> <a name="idp57697584-bb"></a><span class="identifier">remove</span><span class="special">(</span><span class="keyword">int</span> shmid<span class="special">)</span><span class="special">;</span></pre> <p>Erases the XSI shared memory object identified by shmid from the system. Returns false on error. Never throws </p> </li></ol></div> </div> |