<!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: MMAP (Memory Map) 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>MMAP (Memory Map) 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>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#g3b178eb8bdd4ba1dada0bbd64b42d350">APR_MMAP_READ</a> 1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#g550403adecdeea91d17c615b0f74e3d5">APR_MMAP_WRITE</a> 2</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#g6d912948d6996ffe5d448f27babf16ad">APR_MMAP_THRESHOLD</a> 1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#ge8414d1cdeacfaec55c2ef3b93722a84">APR_MMAP_LIMIT</a> (4*1024*1024)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#g7b2ff96acf96a27aa8e54076110b5b9a">APR_MMAP_CANDIDATE</a>(filelength) ((filelength >= APR_MMAP_THRESHOLD) && (filelength < APR_MMAP_LIMIT))</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="structapr__mmap__t.html">apr_mmap_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apr__mmap.html#g69d9aa84488809d9d1db0482eb087e2d">apr_mmap_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__mmap.html#gc95e26c79144f9dde2fcefd167f9d302">apr_mmap_create</a> (<a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> **newmmap, <a class="el" href="group__apr__file__io.html#g804ab64a6f58ddcc3da8d9f54b6f51c2">apr_file_t</a> *file, apr_off_t offset, apr_size_t size, apr_int32_t flag, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *cntxt)</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__mmap.html#gad645ce7da25f7bfee2daccbd0f0475b">apr_mmap_dup</a> (<a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> **new_mmap, <a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> *old_mmap, <a class="el" href="group__apr__pools.html#g06f17a7732f2d04d8ce7010fbb057a8b">apr_pool_t</a> *p)</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__mmap.html#gee1ce85626fa74ec5624c5cb4d33ad68">apr_mmap_delete</a> (<a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> *mm)</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__mmap.html#gdb8d2b0d952aa60ca0590bebf982cd98">apr_mmap_offset</a> (void **addr, <a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> *mm, apr_off_t offset)</td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="g7b2ff96acf96a27aa8e54076110b5b9a"></a><!-- doxytag: member="apr_mmap.h::APR_MMAP_CANDIDATE" ref="g7b2ff96acf96a27aa8e54076110b5b9a" args="(filelength)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_CANDIDATE </td>
<td>(</td>
<td class="paramtype">filelength </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> ((filelength >= APR_MMAP_THRESHOLD) && (filelength < APR_MMAP_LIMIT))</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Can this file be MMaped
</div>
</div><p>
<a class="anchor" name="ge8414d1cdeacfaec55c2ef3b93722a84"></a><!-- doxytag: member="apr_mmap.h::APR_MMAP_LIMIT" ref="ge8414d1cdeacfaec55c2ef3b93722a84" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_LIMIT (4*1024*1024) </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Maximum size of MMap region
</div>
</div><p>
<a class="anchor" name="g3b178eb8bdd4ba1dada0bbd64b42d350"></a><!-- doxytag: member="apr_mmap.h::APR_MMAP_READ" ref="g3b178eb8bdd4ba1dada0bbd64b42d350" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_READ 1 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
MMap opened for reading
</div>
</div><p>
<a class="anchor" name="g6d912948d6996ffe5d448f27babf16ad"></a><!-- doxytag: member="apr_mmap.h::APR_MMAP_THRESHOLD" ref="g6d912948d6996ffe5d448f27babf16ad" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_THRESHOLD 1 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Files have to be at least this big before they're mmap()d. This is to deal with systems where the expense of doing an mmap() and an munmap() outweighs the benefit for small files. It shouldn't be set lower than 1.
</div>
</div><p>
<a class="anchor" name="g550403adecdeea91d17c615b0f74e3d5"></a><!-- doxytag: member="apr_mmap.h::APR_MMAP_WRITE" ref="g550403adecdeea91d17c615b0f74e3d5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define APR_MMAP_WRITE 2 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
MMap opened for writing
</div>
</div><p>
<hr><h2>Typedef Documentation</h2>
<a class="anchor" name="g69d9aa84488809d9d1db0482eb087e2d"></a><!-- doxytag: member="apr_mmap.h::apr_mmap_t" ref="g69d9aa84488809d9d1db0482eb087e2d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> <a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> </dd></dl>
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="gc95e26c79144f9dde2fcefd167f9d302"></a><!-- doxytag: member="apr_mmap.h::apr_mmap_create" ref="gc95e26c79144f9dde2fcefd167f9d302" args="(apr_mmap_t **newmmap, apr_file_t *file, apr_off_t offset, apr_size_t size, apr_int32_t flag, apr_pool_t *cntxt)" -->
<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_mmap_create </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> ** </td>
<td class="paramname"> <em>newmmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__apr__file__io.html#g804ab64a6f58ddcc3da8d9f54b6f51c2">apr_file_t</a> * </td>
<td class="paramname"> <em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_off_t </td>
<td class="paramname"> <em>offset</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_size_t </td>
<td class="paramname"> <em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_int32_t </td>
<td class="paramname"> <em>flag</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>cntxt</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 a new mmap'ed file out of an existing APR file. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newmmap</em> </td><td>The newly created mmap'ed file. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>file</em> </td><td>The file turn into an mmap. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>The offset into the file to start the data pointer at. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>The size of the file </td></tr>
<tr><td valign="top"></td><td valign="top"><em>flag</em> </td><td>bit-wise or of: <pre>
APR_MMAP_READ MMap opened for reading
APR_MMAP_WRITE MMap opened for writing
</pre> </td></tr>
<tr><td valign="top"></td><td valign="top"><em>cntxt</em> </td><td>The pool to use when creating the mmap. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gee1ce85626fa74ec5624c5cb4d33ad68"></a><!-- doxytag: member="apr_mmap.h::apr_mmap_delete" ref="gee1ce85626fa74ec5624c5cb4d33ad68" args="(apr_mmap_t *mm)" -->
<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_mmap_delete </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> * </td>
<td class="paramname"> <em>mm</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove a mmap'ed. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>mm</em> </td><td>The mmap'ed file. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gad645ce7da25f7bfee2daccbd0f0475b"></a><!-- doxytag: member="apr_mmap.h::apr_mmap_dup" ref="gad645ce7da25f7bfee2daccbd0f0475b" args="(apr_mmap_t **new_mmap, apr_mmap_t *old_mmap, apr_pool_t *p)" -->
<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_mmap_dup </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> ** </td>
<td class="paramname"> <em>new_mmap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> * </td>
<td class="paramname"> <em>old_mmap</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>p</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>
Duplicate the specified MMAP. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>new_mmap</em> </td><td>The structure to duplicate into. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>old_mmap</em> </td><td>The mmap to duplicate. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>The pool to use for new_mmap. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="gdb8d2b0d952aa60ca0590bebf982cd98"></a><!-- doxytag: member="apr_mmap.h::apr_mmap_offset" ref="gdb8d2b0d952aa60ca0590bebf982cd98" args="(void **addr, apr_mmap_t *mm, apr_off_t offset)" -->
<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_mmap_offset </td>
<td>(</td>
<td class="paramtype">void ** </td>
<td class="paramname"> <em>addr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structapr__mmap__t.html">apr_mmap_t</a> * </td>
<td class="paramname"> <em>mm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">apr_off_t </td>
<td class="paramname"> <em>offset</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>
Move the pointer into the mmap'ed file to the specified offset. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>addr</em> </td><td>The pointer to the offset specified. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>mm</em> </td><td>The mmap'ed file. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>The offset to move to. </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>
