<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Apache Portable Runtime: Shared Memory Routines</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<h1>Shared Memory Routines<br>
<small>
[<a class="el" href="group___a_p_r.html">Apache Portability Runtime library</a>]</small>
</h1><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__shm.html#g3d4f8c4dffc938abc51c744e56e8f6e9">apr_shm_create</a> (<a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> **m, apr_size_t reqsize, const char *filename, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__shm.html#g3c73d5625d42ea8653f7688a7e4222f4">apr_shm_remove</a> (const char *filename, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__shm.html#g557b940ae98216d2ea82717c8d52b2ee">apr_shm_destroy</a> (<a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> *m)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__shm.html#gbe738c7f7f2c01dff699c0b69a58f87e">apr_shm_attach</a> (<a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> **m, const char *filename, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *pool)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__shm.html#g648fe13f9141f27b19ad68a682f8fde1">apr_shm_detach</a> (<a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> *m)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__shm.html#g288c1a74b6a97a091aaa42df9ea24bef">apr_shm_baseaddr_get</a> (const <a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> *m)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__shm.html#g101f29447e2077bfa85205d963bec6d4">apr_shm_size_get</a> (const <a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> *m)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__shm.html#g20b5398ec414db52a9d861c62a3499e6">apr_shm_pool_get</a> (const <a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> *theshm)</td></tr>
</table>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="g84034931b2165ee5cd056a8e23b12139"></a><!-- doxytag: member="apr_shm.h::apr_shm_t" ref="g84034931b2165ee5cd056a8e23b12139" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> <a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Private, platform-specific data struture representing a shared memory segment.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gbe738c7f7f2c01dff699c0b69a58f87e"></a><!-- doxytag: member="apr_shm.h::apr_shm_attach" ref="gbe738c7f7f2c01dff699c0b69a58f87e" args="(apr_shm_t **m, const char *filename, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_shm_attach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> ** </td>
<td class="paramname"> <em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> * </td>
<td class="paramname"> <em>pool</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attach to a shared memory segment that was created by another process. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>The shared memory structure to create. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The file used to create the original segment. (This MUST match the original filename.) </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>the pool from which to allocate the shared memory structure for this process. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g288c1a74b6a97a091aaa42df9ea24bef"></a><!-- doxytag: member="apr_shm.h::apr_shm_baseaddr_get" ref="g288c1a74b6a97a091aaa42df9ea24bef" args="(const apr_shm_t *m)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* apr_shm_baseaddr_get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> * </td>
<td class="paramname"> <em>m</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the base address of the shared memory segment. NOTE: This address is only usable within the callers address space, since this API does not guarantee that other attaching processes will maintain the same address mapping. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>The shared memory segment from which to retrieve the base address. </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>address, aligned by APR_ALIGN_DEFAULT. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g3d4f8c4dffc938abc51c744e56e8f6e9"></a><!-- doxytag: member="apr_shm.h::apr_shm_create" ref="g3d4f8c4dffc938abc51c744e56e8f6e9" args="(apr_shm_t **m, apr_size_t reqsize, const char *filename, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_shm_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> ** </td>
<td class="paramname"> <em>m</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t </td>
<td class="paramname"> <em>reqsize</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> * </td>
<td class="paramname"> <em>pool</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create and make accessable a shared memory segment. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>The shared memory structure to create. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reqsize</em> </td><td>The desired size of the segment. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The file to use for shared memory on platforms that require it. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>the pool from which to allocate the shared memory structure. </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>A note about Anonymous vs. Named shared memory segments: Not all plaforms support anonymous shared memory segments, but in some cases it is prefered over other types of shared memory implementations. Passing a NULL 'file' parameter to this function will cause the subsystem to use anonymous shared memory segments. If such a system is not available, APR_ENOTIMPL is returned. <p>
A note about allocation sizes: On some platforms it is necessary to store some metainformation about the segment within the actual segment. In order to supply the caller with the requested size it may be necessary for the implementation to request a slightly greater segment length from the subsystem. In all cases, the <a class="el" href="group__apr__shm.html#g288c1a74b6a97a091aaa42df9ea24bef">apr_shm_baseaddr_get()</a> function will return the first usable byte of memory. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g557b940ae98216d2ea82717c8d52b2ee"></a><!-- doxytag: member="apr_shm.h::apr_shm_destroy" ref="g557b940ae98216d2ea82717c8d52b2ee" args="(apr_shm_t *m)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_shm_destroy </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> * </td>
<td class="paramname"> <em>m</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy a shared memory segment and associated memory. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>The shared memory segment structure to destroy. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g648fe13f9141f27b19ad68a682f8fde1"></a><!-- doxytag: member="apr_shm.h::apr_shm_detach" ref="g648fe13f9141f27b19ad68a682f8fde1" args="(apr_shm_t *m)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_shm_detach </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> * </td>
<td class="paramname"> <em>m</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Detach from a shared memory segment without destroying it. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>The shared memory structure representing the segment to detach from. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="g20b5398ec414db52a9d861c62a3499e6"></a><!-- doxytag: member="apr_shm.h::apr_shm_pool_get" ref="g20b5398ec414db52a9d861c62a3499e6" args="(const apr_shm_t *theshm)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a>* apr_shm_pool_get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> * </td>
<td class="paramname"> <em>theshm</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the pool used by this shared memory segment.
</div>
</div><p>
<a class="anchor" name="g3c73d5625d42ea8653f7688a7e4222f4"></a><!-- doxytag: member="apr_shm.h::apr_shm_remove" ref="g3c73d5625d42ea8653f7688a7e4222f4" args="(const char *filename, apr_pool_t *pool)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__apr__errno.html#g4cf2ddae3efce70c508ac7fefc1c47f7">apr_status_t</a> apr_shm_remove </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>filename</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> * </td>
<td class="paramname"> <em>pool</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove shared memory segment associated with a filename. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>The filename associated with shared-memory segment which needs to be removed </td></tr>
<tr><td valign="top"></td><td valign="top"><em>pool</em> </td><td>The pool used for file operations </td></tr>
</table>
</dl>
<dl compact><dt><b>Remarks:</b></dt><dd>This function is only supported on platforms which support name-based shared memory segments, and will return APR_ENOTIMPL on platforms without such support. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g101f29447e2077bfa85205d963bec6d4"></a><!-- doxytag: member="apr_shm.h::apr_shm_size_get" ref="g101f29447e2077bfa85205d963bec6d4" args="(const apr_shm_t *m)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">apr_size_t apr_shm_size_get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__apr__shm.html#g84034931b2165ee5cd056a8e23b12139">apr_shm_t</a> * </td>
<td class="paramname"> <em>m</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Retrieve the length of a shared memory segment in bytes. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>m</em> </td><td>The shared memory segment from which to retrieve the segment length. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Tue May 31 12:20:26 2011 for Apache Portable Runtime by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
