diff options
Diffstat (limited to 'doc/html/boost/interprocess/windows_shared_memory.html')
| -rw-r--r-- | doc/html/boost/interprocess/windows_shared_memory.html | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/doc/html/boost/interprocess/windows_shared_memory.html b/doc/html/boost/interprocess/windows_shared_memory.html index 03270fff99..37979bb24b 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#idm46037321223904-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#idm46037321222416-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#idp48752800-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#idp48754288-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#idm46037321216688-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#idp48760016-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#idm46037321210912-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#idm46037321207888-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#idm46037321206080-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#idm46037321203712-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#idp48765792-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#idp48768816-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#idp48770624-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#idp48772992-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#idm46037321232672-bb">public member functions</a></span> - <span class="keyword">void</span> <a class="link" href="windows_shared_memory.html#idm46037321232112-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#idm46037321229968-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#idm46037321228544-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#idm46037321227136-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#idm46037321225696-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#idp48744032-bb">public member functions</a></span> + <span class="keyword">void</span> <a class="link" href="windows_shared_memory.html#idp48744592-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#idp48746736-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#idp48748160-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#idp48749568-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#idp48751008-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="idm45928005224512"></a><h2>Description</h2> +<a name="idp388370064"></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="idm45928005219680"></a><h3> +<a name="idp388374896"></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="idm46037321223904-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="idp48752800-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="idm46037321222416-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="idp48754288-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="idm46037321216688-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="idp48760016-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="idm46037321210912-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="idp48765792-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="idm46037321207888-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="idp48768816-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="idm46037321206080-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="idp48770624-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="idm46037321203712-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="idp48772992-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="idm45928005151072"></a><h3> -<a name="idm46037321232672-bb"></a><code class="computeroutput">windows_shared_memory</code> public member functions</h3> +<a name="idp388443728"></a><h3> +<a name="idp48744032-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="idm46037321232112-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="idp48744592-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="idm46037321229968-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="idp48746736-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="idm46037321228544-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="idp48748160-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="idm46037321227136-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="idp48749568-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="idm46037321225696-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="idp48751008-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> |