Share Library (C++)
File detail
Source code
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>ShareLibrary: Share::SharedSegmentWrapper 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.5.2 -->
<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="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.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>
</ul>
</div>
<div class="tabs">
<ul>
<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="namespaceShare.html">Share</a>::<a class="el" href="classShare_1_1SharedSegmentWrapper.html">SharedSegmentWrapper</a></div>
<h1>Share::SharedSegmentWrapper Class Reference<br>
<small>
[<a class="el" href="group__sharectl.html">sharectl utility</a>]</small>
</h1><!-- doxytag: class="Share::SharedSegmentWrapper" -->Wrapper around <a class="el" href="classShare_1_1SharedSegment.html" title="Platform independent shared segment representation.">SharedSegment</a> class for sharectl.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="sharectl_8h-source.html">sharectl.h</a>></code>
<p>
Collaboration diagram for Share::SharedSegmentWrapper:<p><center><img src="classShare_1_1SharedSegmentWrapper__coll__graph.png" border="0" usemap="#Share_1_1SharedSegmentWrapper__coll__map" alt="Collaboration graph"></center>
<map name="Share_1_1SharedSegmentWrapper__coll__map">
<area shape="rect" href="classShare_1_1SharedSegment.html" title="Platform independent shared segment representation." alt="" coords="35,5,216,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classShare_1_1SharedSegmentWrapper-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="classShare_1_1SharedSegmentWrapper.html#99a3c82fa42fd86ce9ca144f46e79bc7">SharedSegmentWrapper</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1SharedSegmentWrapper.html#ad25778cd515e8bff4160835f81c181b">~SharedSegmentWrapper</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1SharedSegmentWrapper.html#d95f794d8b81fc2de9b0cda1a0f2f331">create</a> (const char *name, size_t size) throw (ShareException)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1SharedSegmentWrapper.html#1efb4446afdd8653b0d3a35ea9fce986">attach</a> (const char *name) throw (ShareException)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classShare_1_1SegmentHeader.html">SegmentHeader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1SharedSegmentWrapper.html#daa43c09926cde7de8d3338b0e126130">atAddr</a> () throw (ShareException)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1SharedSegmentWrapper.html#feca03474403e7fdf671651817f9e8af">destroy</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Wrapper around <a class="el" href="classShare_1_1SharedSegment.html" title="Platform independent shared segment representation.">SharedSegment</a> class for sharectl.
<p>
<p>
Definition at line <a class="el" href="sharectl_8h-source.html#l00106">106</a> of file <a class="el" href="sharectl_8h-source.html">sharectl.h</a>.<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="99a3c82fa42fd86ce9ca144f46e79bc7"></a><!-- doxytag: member="Share::SharedSegmentWrapper::SharedSegmentWrapper" ref="99a3c82fa42fd86ce9ca144f46e79bc7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Share::SharedSegmentWrapper::SharedSegmentWrapper </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ad25778cd515e8bff4160835f81c181b"></a><!-- doxytag: member="Share::SharedSegmentWrapper::~SharedSegmentWrapper" ref="ad25778cd515e8bff4160835f81c181b" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Share::SharedSegmentWrapper::~SharedSegmentWrapper </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d95f794d8b81fc2de9b0cda1a0f2f331"></a><!-- doxytag: member="Share::SharedSegmentWrapper::create" ref="d95f794d8b81fc2de9b0cda1a0f2f331" args="(const char *name, size_t size)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Share::SharedSegmentWrapper::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></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"> throw (<a class="el" href="classShare_1_1ShareException.html">ShareException</a>)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create new shared 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>name</em> </td><td>Desired shared segment name. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>size</em> </td><td>Desired shared segment size. </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classShare_1_1ShareException.html" title="General exception carrying text message inside.">ShareException</a></em> </td><td>Library-specific exception derived from std::bad_alloc </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="1efb4446afdd8653b0d3a35ea9fce986"></a><!-- doxytag: member="Share::SharedSegmentWrapper::attach" ref="1efb4446afdd8653b0d3a35ea9fce986" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Share::SharedSegmentWrapper::attach </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em> </td>
<td> ) </td>
<td width="100%"> throw (<a class="el" href="classShare_1_1ShareException.html">ShareException</a>)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attach to existing shared 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>name</em> </td><td>Name of shared segment to attach to </td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em><a class="el" href="classShare_1_1ShareException.html" title="General exception carrying text message inside.">ShareException</a></em> </td><td>Library-specific exception derived from std::bad_alloc </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="daa43c09926cde7de8d3338b0e126130"></a><!-- doxytag: member="Share::SharedSegmentWrapper::atAddr" ref="daa43c09926cde7de8d3338b0e126130" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classShare_1_1SegmentHeader.html">SegmentHeader</a>* Share::SharedSegmentWrapper::atAddr </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> throw (<a class="el" href="classShare_1_1ShareException.html">ShareException</a>)</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Return address of attached shared segment </dd></dl>
</div>
</div><p>
<a class="anchor" name="feca03474403e7fdf671651817f9e8af"></a><!-- doxytag: member="Share::SharedSegmentWrapper::destroy" ref="feca03474403e7fdf671651817f9e8af" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Share::SharedSegmentWrapper::destroy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Attempt to destroy shared segment. No checks are being performed!!
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>sharectl/<a class="el" href="sharectl_8h-source.html">sharectl.h</a></ul>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 26 17:43:03 2007 for ShareLibrary by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.2 </small></address>
</body>
</html>
Back to main page
classShare_1_1SharedSegmentWrapper.html [Download]