<!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>GNU CommonC++: ost::MappedFile Class Reference</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.6 --> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li id="current"><a href="classes.html"><span>Classes</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> <div class="tabs"> <ul> <li><a href="classes.html"><span>Alphabetical List</span></a></li> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul></div> <div class="nav"> <a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_mapped_file.html">MappedFile</a></div> <h1>ost::MappedFile Class Reference</h1><!-- doxytag: class="ost::MappedFile" --><!-- doxytag: inherits="ost::RandomFile" -->Create and map a disk file into memory.Map a named disk file into memory. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="file_8h-source.html">file.h</a>></code> <p> <p>Inheritance diagram for ost::MappedFile: <p><center><img src="classost_1_1_mapped_file.png" usemap="#ost::MappedFile_map" border="0" alt=""></center> <map name="ost::MappedFile_map"> <area href="classost_1_1_random_file.html" alt="ost::RandomFile" shape="rect" coords="55,56,156,80"> <area href="classost_1_1_mutex.html" alt="ost::Mutex" shape="rect" coords="0,0,101,24"> <area href="classost_1_1_file.html" alt="ost::File" shape="rect" coords="111,0,212,24"> </map> <a href="classost_1_1_mapped_file-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#1d8d79711c6d0874ef50f0fee1d768ee">MappedFile</a> (const char *fname, <a class="el" href="classost_1_1_file.html#bb89129e6b212f038cfbf591a791a48e">Access</a> mode)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Open a file for mapping. <a href="#1d8d79711c6d0874ef50f0fee1d768ee"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#65b2b05ede145124ba7d903f2c118b28">MappedFile</a> (const char *fname, <a class="el" href="classost_1_1_file.html#bb89129e6b212f038cfbf591a791a48e">Access</a> mode, size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Create if not exists, and map a file of specified size into memory. <a href="#65b2b05ede145124ba7d903f2c118b28"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#dbf54b1e56999a84f4a017d0c9b82405">MappedFile</a> (const char *fname, <a class="el" href="namespaceost.html#4bb988be58c6264b160ef2d6ceb178e5">pos_t</a> offset, size_t size, <a class="el" href="classost_1_1_file.html#bb89129e6b212f038cfbf591a791a48e">Access</a> mode)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Map a portion or all of a specified file in the specified shared memory access mode. <a href="#dbf54b1e56999a84f4a017d0c9b82405"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#349f9927a4bfe1106955f1d44959ab2b">~MappedFile</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Release a mapped section of memory associated with a file. <a href="#349f9927a4bfe1106955f1d44959ab2b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#f5fe36ccac8879fd2ca8b63574686cac">sync</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Synchronize the contents of the mapped portion of memory with the disk file and wait for completion. <a href="#f5fe36ccac8879fd2ca8b63574686cac"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#057579ccc63c7e06190abea4bba9a43e">sync</a> (char *address, size_t len)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Synchronize a segment of memory mapped from a segment fetch. <a href="#057579ccc63c7e06190abea4bba9a43e"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#99b20ddc2524e8ec1ce544d362e786b3">update</a> (size_t offset=0, size_t len=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Map a portion of the memory mapped from the file back to the file and do not wait for completion. <a href="#99b20ddc2524e8ec1ce544d362e786b3"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#6fd5874fd9ffe5f058775b3d34a95064">update</a> (char *address, size_t len)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Update a mapped region back to disk as specified by address and length. <a href="#6fd5874fd9ffe5f058775b3d34a95064"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#58b384efa39d1fc1d8833974209de206">release</a> (char *address, size_t len)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Release (unmap) a memory segment. <a href="#58b384efa39d1fc1d8833974209de206"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#0d8be211f29d23d39051a86512dee853">fetch</a> (size_t offset=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch a pointer to an offset within the memory mapped portion of the disk file. <a href="#0d8be211f29d23d39051a86512dee853"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#7c8db51c98075be049e6ae2efc7966c2">fetch</a> (off_t pos, size_t len)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Fetch and map a portion of a disk file to a logical memory block. <a href="#7c8db51c98075be049e6ae2efc7966c2"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#b94baac40118fa5c6903ce42109c7903">lock</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Lock the currently mapped portion of a file. <a href="#b94baac40118fa5c6903ce42109c7903"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#47776d201f8d2f8f9f0288f797e3da4c">unlock</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Unlock a locked mapped portion of a file. <a href="#47776d201f8d2f8f9f0288f797e3da4c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_mapped_file.html#f6498463d62c3e69d10919f8687b95ea">pageAligned</a> (size_t size)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Compute map size to aligned page boundry. <a href="#f6498463d62c3e69d10919f8687b95ea"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Create and map a disk file into memory.Map a named disk file into memory. <p> This portable class works under both Posix via mmap and under the win32 API. A mapped file can be referenced directly by it's memory segment. One can map and unmap portions of a file on demand, and update changed memory pages mapped from files immediately through <a class="el" href="classost_1_1_mapped_file.html#f5fe36ccac8879fd2ca8b63574686cac">sync()</a>.<p> <dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl> <p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="1d8d79711c6d0874ef50f0fee1d768ee"></a><!-- doxytag: member="ost::MappedFile::MappedFile" ref="1d8d79711c6d0874ef50f0fee1d768ee" args="(const char *fname, Access mode)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">ost::MappedFile::MappedFile </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const char * </td> <td class="mdname" nowrap> <em>fname</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="el" href="classost_1_1_file.html#bb89129e6b212f038cfbf591a791a48e">Access</a> </td> <td class="mdname" nowrap> <em>mode</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Open a file for mapping. <p> More than one segment of a file may be mapped into seperate regions of memory.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>fname</em> </td><td>file name to access for mapping. </td></tr> <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>access mode to map file. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="65b2b05ede145124ba7d903f2c118b28"></a><!-- doxytag: member="ost::MappedFile::MappedFile" ref="65b2b05ede145124ba7d903f2c118b28" args="(const char *fname, Access mode, size_t size)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">ost::MappedFile::MappedFile </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const char * </td> <td class="mdname" nowrap> <em>fname</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="el" href="classost_1_1_file.html#bb89129e6b212f038cfbf591a791a48e">Access</a> </td> <td class="mdname" nowrap> <em>mode</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>size_t </td> <td class="mdname" nowrap> <em>size</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Create if not exists, and map a file of specified size into memory. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>fname</em> </td><td>file name to access for mapping. </td></tr> <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>access mode to map file. </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of file to map. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="dbf54b1e56999a84f4a017d0c9b82405"></a><!-- doxytag: member="ost::MappedFile::MappedFile" ref="dbf54b1e56999a84f4a017d0c9b82405" args="(const char *fname, pos_t offset, size_t size, Access mode)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">ost::MappedFile::MappedFile </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">const char * </td> <td class="mdname" nowrap> <em>fname</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="el" href="namespaceost.html#4bb988be58c6264b160ef2d6ceb178e5">pos_t</a> </td> <td class="mdname" nowrap> <em>offset</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>size_t </td> <td class="mdname" nowrap> <em>size</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap><a class="el" href="classost_1_1_file.html#bb89129e6b212f038cfbf591a791a48e">Access</a> </td> <td class="mdname" nowrap> <em>mode</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Map a portion or all of a specified file in the specified shared memory access mode. <p> Valid mapping modes include mappedRead, mappedWrite, and mappedReadWrite.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>fname</em> </td><td>pathname of file to map into memory. </td></tr> <tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>from start of file to begin mapping in bytes. </td></tr> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>of mapped area in bytes. </td></tr> <tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>to map file. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="349f9927a4bfe1106955f1d44959ab2b"></a><!-- doxytag: member="ost::MappedFile::~MappedFile" ref="349f9927a4bfe1106955f1d44959ab2b" args="()" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">virtual ost::MappedFile::~MappedFile </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Release a mapped section of memory associated with a file. <p> The mapped area is updated back to disk. </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="7c8db51c98075be049e6ae2efc7966c2"></a><!-- doxytag: member="ost::MappedFile::fetch" ref="7c8db51c98075be049e6ae2efc7966c2" args="(off_t pos, size_t len)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">char* ost::MappedFile::fetch </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">off_t </td> <td class="mdname" nowrap> <em>pos</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>size_t </td> <td class="mdname" nowrap> <em>len</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Fetch and map a portion of a disk file to a logical memory block. <p> <dl compact><dt><b>Returns:</b></dt><dd>pointer to memory segment. </dd></dl> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>pos</em> </td><td>offset of file segment to map. </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>size of memory segment to map. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="0d8be211f29d23d39051a86512dee853"></a><!-- doxytag: member="ost::MappedFile::fetch" ref="0d8be211f29d23d39051a86512dee853" args="(size_t offset=0)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">char* ost::MappedFile::fetch </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">size_t </td> <td class="mdname1" valign="top" nowrap> <em>offset</em> = <code>0</code> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [inline]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Fetch a pointer to an offset within the memory mapped portion of the disk file. <p> This really is used for convience of matching operations between Update and Fetch, as one could simply have accessed the base pointer where the file was mapped directly.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>from start of mapped memory. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="b94baac40118fa5c6903ce42109c7903"></a><!-- doxytag: member="ost::MappedFile::lock" ref="b94baac40118fa5c6903ce42109c7903" args="(void)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">bool ost::MappedFile::lock </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Lock the currently mapped portion of a file. <p> <dl compact><dt><b>Returns:</b></dt><dd>true if pages are locked. </dd></dl> </td> </tr> </table> <a class="anchor" name="f6498463d62c3e69d10919f8687b95ea"></a><!-- doxytag: member="ost::MappedFile::pageAligned" ref="f6498463d62c3e69d10919f8687b95ea" args="(size_t size)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">size_t ost::MappedFile::pageAligned </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">size_t </td> <td class="mdname1" valign="top" nowrap> <em>size</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Compute map size to aligned page boundry. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>request. </td></tr> </table> </dl> <dl compact><dt><b>Returns:</b></dt><dd>page aligned size. </dd></dl> </td> </tr> </table> <a class="anchor" name="58b384efa39d1fc1d8833974209de206"></a><!-- doxytag: member="ost::MappedFile::release" ref="58b384efa39d1fc1d8833974209de206" args="(char *address, size_t len)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void ost::MappedFile::release </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char * </td> <td class="mdname" nowrap> <em>address</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>size_t </td> <td class="mdname" nowrap> <em>len</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Release (unmap) a memory segment. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>address of memory segment to release. </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>length of memory segment to release. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="057579ccc63c7e06190abea4bba9a43e"></a><!-- doxytag: member="ost::MappedFile::sync" ref="057579ccc63c7e06190abea4bba9a43e" args="(char *address, size_t len)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void ost::MappedFile::sync </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char * </td> <td class="mdname" nowrap> <em>address</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>size_t </td> <td class="mdname" nowrap> <em>len</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Synchronize a segment of memory mapped from a segment fetch. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>memory address to update. </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>size of segment. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="f5fe36ccac8879fd2ca8b63574686cac"></a><!-- doxytag: member="ost::MappedFile::sync" ref="f5fe36ccac8879fd2ca8b63574686cac" args="(void)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void ost::MappedFile::sync </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Synchronize the contents of the mapped portion of memory with the disk file and wait for completion. <p> This assures the memory mapped from the file is written back. </td> </tr> </table> <a class="anchor" name="47776d201f8d2f8f9f0288f797e3da4c"></a><!-- doxytag: member="ost::MappedFile::unlock" ref="47776d201f8d2f8f9f0288f797e3da4c" args="(void)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void ost::MappedFile::unlock </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Unlock a locked mapped portion of a file. <p> </td> </tr> </table> <a class="anchor" name="6fd5874fd9ffe5f058775b3d34a95064"></a><!-- doxytag: member="ost::MappedFile::update" ref="6fd5874fd9ffe5f058775b3d34a95064" args="(char *address, size_t len)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void ost::MappedFile::update </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">char * </td> <td class="mdname" nowrap> <em>address</em>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>size_t </td> <td class="mdname" nowrap> <em>len</em></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Update a mapped region back to disk as specified by address and length. <p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>address</em> </td><td>address of segment. </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>length of segment. </td></tr> </table> </dl> </td> </tr> </table> <a class="anchor" name="99b20ddc2524e8ec1ce544d362e786b3"></a><!-- doxytag: member="ost::MappedFile::update" ref="99b20ddc2524e8ec1ce544d362e786b3" args="(size_t offset=0, size_t len=0)" --><p> <table class="mdTable" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top">void ost::MappedFile::update </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">size_t </td> <td class="mdname" nowrap> <em>offset</em> = <code>0</code>, </td> </tr> <tr> <td class="md" nowrap align="right"></td> <td class="md"></td> <td class="md" nowrap>size_t </td> <td class="mdname" nowrap> <em>len</em> = <code>0</code></td> </tr> <tr> <td class="md"></td> <td class="md">) </td> <td class="md" colspan="2"></td> </tr> </table> </td> </tr> </table> <table cellspacing="5" cellpadding="0" border="0"> <tr> <td> </td> <td> <p> Map a portion of the memory mapped from the file back to the file and do not wait for completion. <p> This is useful when mapping a database file and updating a single record.<p> <dl compact><dt><b>Parameters:</b></dt><dd> <table border="0" cellspacing="2" cellpadding="0"> <tr><td valign="top"></td><td valign="top"><em>offset</em> </td><td>offset into the mapped region of memory. </td></tr> <tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>length of partial region (example, record length). </td></tr> </table> </dl> </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="file_8h-source.html">file.h</a></ul> <hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address> </body> </html>