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: sharectl utility</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><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>
<h1>sharectl utility</h1><code>sharectl</code> is command-line utility for manipulating with shared segment.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Files</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="sharectl_8h.html">sharectl.h</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command-line utility manipulating with shared segment. <br></td></tr>
<p>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1ArgParser.html">Share::ArgParser</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parser for commnad-line arguments of sharectl utility. <a href="classShare_1_1ArgParser.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1ArgSwitchChecker.html">Share::ArgSwitchChecker</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command-lnie switches mapping from string to enum. <a href="classShare_1_1ArgSwitchChecker.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1SharedSegmentWrapper.html">Share::SharedSegmentWrapper</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper around <a class="el" href="classShare_1_1SharedSegment.html" title="Platform independent shared segment representation.">SharedSegment</a> class for sharectl. <a href="classShare_1_1SharedSegmentWrapper.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classShare_1_1SegmentDebuger.html">Share::SegmentDebuger</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wrapper around <a class="el" href="classShare_1_1SegmentHeader.html" title="Object placed at begin of each shared segment.">SegmentHeader</a> class for sharectl. <a href="classShare_1_1SegmentDebuger.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sharectl.html#gd3ef2512b0836d9e479bc6a2b78fccaa">Share::ShareManager::initDebugMode</a> (SharedSegment *segment)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize <a class="el" href="classShare_1_1ShareManager.html" title="Gateway to shared segment">ShareManager</a> for debuging. <a href="#gd3ef2512b0836d9e479bc6a2b78fccaa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__sharectl.html#g89b04983af322afc2c8fb1dafdcd3015">Share::ShareManager::destroySegment</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy current shared segment immediately. <a href="#g89b04983af322afc2c8fb1dafdcd3015"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<code>sharectl</code> is command-line utility for manipulating with shared segment.
<p>
<h3>Usage</h3>
<p style="margin-left:2em;"><code>sharectl SEGMENT_NAME [SWITCH] [...]</code></p>
<table style="margin-left:4em;">
<tr><td style="font-family:monospace">--create</td><td style="padding-left:2em;">Create new shared segment of specified size.</td></tr>
<tr><td style="font-family:monospace">--create-and-wait</td><td style="padding-left:2em;">Create new shared segment of specified size and wait until key pressed.</td></tr>
<tr><td style="font-family:monospace">--notify-attach</td><td style="padding-left:2em;">Increase internal reference counter.</td></tr>
<tr><td style="font-family:monospace">--notify-detach</td><td style="padding-left:2em;">Decrease internal reference counter.</td></tr>
<tr><td style="font-family:monospace">--unlink</td><td style="padding-left:2em;">Mark segment to be destroyed.</td></tr>
<tr><td style="font-family:monospace">--force-destroy</td><td style="padding-left:2em;">Destroy segment immediately.</td></tr>
<tr><td style="font-family:monospace">--alloc</td><td style="padding-left:2em;">Allocate block of specified size inside shared segment.</td></tr>
<tr><td style="font-family:monospace">--free</td><td style="padding-left:2em;">Free block identified by relative pointer (number)</td></tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g89b04983af322afc2c8fb1dafdcd3015"></a><!-- doxytag: member="Share::ShareManager::destroySegment" ref="g89b04983af322afc2c8fb1dafdcd3015" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Share::ShareManager::destroySegment </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy current shared segment immediately.
<p>
</div>
</div><p>
<a class="anchor" name="gd3ef2512b0836d9e479bc6a2b78fccaa"></a><!-- doxytag: member="Share::ShareManager::initDebugMode" ref="gd3ef2512b0836d9e479bc6a2b78fccaa" args="(SharedSegment *segment)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Share::ShareManager::initDebugMode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classShare_1_1SharedSegment.html">SharedSegment</a> * </td>
<td class="paramname"> <em>segment</em> </td>
<td> ) </td>
<td width="100%"><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize <a class="el" href="classShare_1_1ShareManager.html" title="Gateway to shared segment">ShareManager</a> for debuging.
<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>segment</em> </td><td>Pointer to initialized segment object </td></tr>
</table>
</dl>
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Sun Aug 26 17:43:00 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
group__sharectl.html [Download]