<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>ucommon: MappedMemory Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.3 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ucommon</div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('a00075.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<h1>MappedMemory Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="MappedMemory" -->
<p>Construct or access a named section of memory.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00188_source.html">mapped.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for MappedMemory:</div>
<div class="dyncontent">
<div class="center"><img src="a00362.png" border="0" usemap="#_mapped_memory_inherit__map" alt="Inheritance graph"/></div>
<map name="_mapped_memory_inherit__map" id="_mapped_memory_inherit__map">
<area shape="rect" id="node3" href="a00072.html" title="Template class to map typed vector into shared memory." alt="" coords="5,80,197,107"/><area shape="rect" id="node5" href="a00074.html" title="Class to access a named mapped segment published from another process." alt="" coords="221,80,403,107"/><area shape="rect" id="node7" href="a00076.html" title="Map a reusable allocator over a named shared memory segment." alt="" coords="427,80,557,107"/><area shape="rect" id="node9" href="a00073.html" title="Template class to map typed reusable objects into shared memory heap." alt="" coords="396,155,588,181"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">caddr_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#acf7c90f44e2536ea1c06d9e972e5841b">getStart</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get starting address of mapped segment. <a href="#acf7c90f44e2536ea1c06d9e972e5841b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#a68809a3e2c9bc3645ad99c57fb0d7eb8">len</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get size of mapped segment. <a href="#a68809a3e2c9bc3645ad99c57fb0d7eb8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#aafa575de23c913aeaceb7f972004692b">MappedMemory</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provide read-only mapped access to an existing named shared memory segment. <a href="#aafa575de23c913aeaceb7f972004692b"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#aed76ba8ea0950ecb533941165a160ef7">MappedMemory</a> (const char *name, size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a read/write access mapped shared segment of memory of a known size. <a href="#aed76ba8ea0950ecb533941165a160ef7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#a62dca2b2f5228c6b6dd533167f47cfd5">offset</a> (size_t offset) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get memory from a specific offset within the mapped memory segment. <a href="#a62dca2b2f5228c6b6dd533167f47cfd5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#afae33c411cc77f9b9f0feab0de6d41a0">operator bool</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if map active. <a href="#afae33c411cc77f9b9f0feab0de6d41a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#a467204cd066978192cbe673f841f2603">operator!</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if map is inactive. <a href="#a467204cd066978192cbe673f841f2603"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00953f6cad27eefa85df773d510b3c8c"></a><!-- doxytag: member="MappedMemory::release" ref="a00953f6cad27eefa85df773d510b3c8c" args="(void)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#a00953f6cad27eefa85df773d510b3c8c">release</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unmap memory segment. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#ad1da2ed514ec7fa9141f6c410e4774c8">sbrk</a> (size_t size)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Extend size of managed heap on shared memory segment. <a href="#ad1da2ed514ec7fa9141f6c410e4774c8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac8a220d7dd0963fc7d2855e3c357bf7a"></a><!-- doxytag: member="MappedMemory::~MappedMemory" ref="ac8a220d7dd0963fc7d2855e3c357bf7a" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#ac8a220d7dd0963fc7d2855e3c357bf7a">~MappedMemory</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unmap memory segment. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#a1922f80c6891bc56aef1230c6a50d114">disable</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An API that allows "disabling" of publishing shared memory maps. <a href="#a1922f80c6891bc56aef1230c6a50d114"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#a40cec2470bdb3e7f51316734ff2b0902">remove</a> (const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy a previously existing memory segment under the specified name. <a href="#a40cec2470bdb3e7f51316734ff2b0902"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#a998dec9756c0d128ee0f149e814cb764">create</a> (const char *name, size_t size=(size_t) 0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Supporting function to construct a new or access an existing shared memory segment. <a href="#a998dec9756c0d128ee0f149e814cb764"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8001e202d11b5b476a2cd128c1fc1823"></a><!-- doxytag: member="MappedMemory::fault" ref="a8001e202d11b5b476a2cd128c1fc1823" args="(void) const " -->
virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00075.html#a8001e202d11b5b476a2cd128c1fc1823">fault</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Handler to invoke in derived class when accessing outside the shared memory segment boundary. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a460661fb294b59765a68beaa3489a2c9"></a><!-- doxytag: member="MappedMemory::erase" ref="a460661fb294b59765a68beaa3489a2c9" args="" -->
bool </td><td class="memItemRight" valign="bottom"><b>erase</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a06fdaf310bfa8280dd112fd1726a2870"></a><!-- doxytag: member="MappedMemory::idname" ref="a06fdaf310bfa8280dd112fd1726a2870" args="[65]" -->
char </td><td class="memItemRight" valign="bottom"><b>idname</b> [65]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1edfd39ad6d36e084563354cbd77a5e6"></a><!-- doxytag: member="MappedMemory::size" ref="a1edfd39ad6d36e084563354cbd77a5e6" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><b>size</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8167158b9df78e93a371bdf3cd74e7a7"></a><!-- doxytag: member="MappedMemory::used" ref="a8167158b9df78e93a371bdf3cd74e7a7" args="" -->
size_t </td><td class="memItemRight" valign="bottom"><b>used</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Construct or access a named section of memory. </p>
<p>A logical name is used which might map to something that is invoked from a call like shm_open or a named w32 mapped swap segment. This is meant to support mapping a vector onto shared memory and is often used as a supporting class for our shared memory access templates. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00058">58</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="aed76ba8ea0950ecb533941165a160ef7"></a><!-- doxytag: member="MappedMemory::MappedMemory" ref="aed76ba8ea0950ecb533941165a160ef7" args="(const char *name, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MappedMemory::MappedMemory </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Construct a read/write access mapped shared segment of memory of a known size. </p>
<p>This constructs a new memory segment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>of segment. </td></tr>
<tr><td class="paramname">size</td><td>of segment. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aafa575de23c913aeaceb7f972004692b"></a><!-- doxytag: member="MappedMemory::MappedMemory" ref="aafa575de23c913aeaceb7f972004692b" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MappedMemory::MappedMemory </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Provide read-only mapped access to an existing named shared memory segment. </p>
<p>The size of the map is found by the size of the already existing segment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>of existing segment. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a998dec9756c0d128ee0f149e814cb764"></a><!-- doxytag: member="MappedMemory::create" ref="a998dec9756c0d128ee0f149e814cb764" args="(const char *name, size_t size=(size_t) 0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void MappedMemory::create </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> = <code>(size_t) 0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Supporting function to construct a new or access an existing shared memory segment. </p>
<p>Used by primary constructors. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>of segment to create or access. </td></tr>
<tr><td class="paramname">size</td><td>of segment if creating new. Use 0 for read-only access. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1922f80c6891bc56aef1230c6a50d114"></a><!-- doxytag: member="MappedMemory::disable" ref="a1922f80c6891bc56aef1230c6a50d114" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void MappedMemory::disable </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>An API that allows "disabling" of publishing shared memory maps. </p>
<p>This may be useful when an app doesn't want to use shared memory as a runtime or build option, but does not want to have to be "recoded" explicitly for non-shared memory either. Basically it substitutes a dummy map running on the local heap. </p>
</div>
</div>
<a class="anchor" id="acf7c90f44e2536ea1c06d9e972e5841b"></a><!-- doxytag: member="MappedMemory::getStart" ref="acf7c90f44e2536ea1c06d9e972e5841b" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">caddr_t MappedMemory::getStart </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get starting address of mapped segment. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>starting address of mapped segment. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00162">162</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a68809a3e2c9bc3645ad99c57fb0d7eb8"></a><!-- doxytag: member="MappedMemory::len" ref="a68809a3e2c9bc3645ad99c57fb0d7eb8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t MappedMemory::len </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get size of mapped segment. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of mapped segment. </dd></dl>
<p>Definition at line <a class="el" href="a00188_source.html#l00155">155</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a62dca2b2f5228c6b6dd533167f47cfd5"></a><!-- doxytag: member="MappedMemory::offset" ref="a62dca2b2f5228c6b6dd533167f47cfd5" args="(size_t offset) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* MappedMemory::offset </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>offset</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get memory from a specific offset within the mapped memory segment. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">offset</td><td>from start of segment. Will fault if past end. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>address of offset. </dd></dl>
</div>
</div>
<a class="anchor" id="afae33c411cc77f9b9f0feab0de6d41a0"></a><!-- doxytag: member="MappedMemory::operator bool" ref="afae33c411cc77f9b9f0feab0de6d41a0" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">MappedMemory::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if map active. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if active map. </dd></dl>
<p>Reimplemented in <a class="el" href="a00073.html#a4c11e4f6a8410208d8d2269199ad5a1f">mapped_reuse< T ></a>.</p>
<p>Definition at line <a class="el" href="a00188_source.html#l00125">125</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a467204cd066978192cbe673f841f2603"></a><!-- doxytag: member="MappedMemory::operator!" ref="a467204cd066978192cbe673f841f2603" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool MappedMemory::operator! </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test if map is inactive. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if map inactive. </dd></dl>
<p>Reimplemented in <a class="el" href="a00073.html#aa43deaef9490aa28c08af4dc38555c14">mapped_reuse< T ></a>.</p>
<p>Definition at line <a class="el" href="a00188_source.html#l00132">132</a> of file <a class="el" href="a00188_source.html">mapped.h</a>.</p>
</div>
</div>
<a class="anchor" id="a40cec2470bdb3e7f51316734ff2b0902"></a><!-- doxytag: member="MappedMemory::remove" ref="a40cec2470bdb3e7f51316734ff2b0902" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static void MappedMemory::remove </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy a previously existing memory segment under the specified name. </p>
<p>This is used both before creating a new one, and after a publishing process unmaps the segment it created. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>of segment to remove. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="ad1da2ed514ec7fa9141f6c410e4774c8"></a><!-- doxytag: member="MappedMemory::sbrk" ref="ad1da2ed514ec7fa9141f6c410e4774c8" args="(size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void* MappedMemory::sbrk </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Extend size of managed heap on shared memory segment. </p>
<p>This does not change the size of the mapped segment in any way, only that of any heap space that is being allocated and used from the mapped segment. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>start of space from map. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">size</td><td>of space requested. Will fault if past end of segment. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00188_source.html">mapped.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="a00075.html">MappedMemory</a> </li>
<li class="footer">Generated on Wed Apr 13 2011 22:39:47 for ucommon by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
</ul>
</div>
</body>
</html>
