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: Internal library classes</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>Internal library classes</h1><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="DefaultAllocator_8h.html">DefaultAllocator.h</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Allocator for blocks inside shared segment. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="DefaultRefCounter_8h.html">DefaultRefCounter.h</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference counter for shared segment. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="MutexLock_8h.html">MutexLock.h</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Platform-independent mutex representation. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="SegmentHeader_8h.html">SegmentHeader.h</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Object placed at begin of each shared segment. <br></td></tr>
<p>
<tr><td class="memItemLeft" nowrap align="right" valign="top">file </td><td class="memItemRight" valign="bottom"><a class="el" href="SharedSegment_8h.html">SharedSegment.h</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Platform-indepent shared segment representation. <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_1DefaultAllocator.html">Share::DefaultAllocator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classShare_1_1Allocator.html" title="STL allocator.">Allocator</a> for blocks inside shared segment. <a href="classShare_1_1DefaultAllocator.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_1DefaultRefCounter.html">Share::DefaultRefCounter</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reference counter for shared segment. <a href="classShare_1_1DefaultRefCounter.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_1Mutex.html">Share::Mutex</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Platform-independent mutex representation. <a href="classShare_1_1Mutex.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structShare_1_1Mutex_1_1LockData.html">Share::Mutex::LockData</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classShare_1_1Mutex.html" title="Platform-independent mutex representation.">Mutex</a> per-lock specific data. <a href="structShare_1_1Mutex_1_1LockData.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_1MutexLock.html">Share::MutexLock</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="classShare_1_1Mutex.html" title="Platform-independent mutex representation.">Mutex</a> lock RAII object. <a href="classShare_1_1MutexLock.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_1SegmentHeader.html">Share::SegmentHeader</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Object placed at begin of each shared segment. <a href="classShare_1_1SegmentHeader.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_1SharedSegment.html">Share::SharedSegment</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Platform independent shared segment representation. <a href="classShare_1_1SharedSegment.html#_details">More...</a><br></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__backend.html#g29a6f4bde0ada26e8614a89d218da1a6">BITS_ALIGNMENT</a> 8</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Define <b>memory</b> <b>alignment</b> in bits that allocator work with. <a href="#g29a6f4bde0ada26e8614a89d218da1a6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<unsigned char bitsAlignment, typename T> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__backend.html#g0bf9356c8f3e57840a77634de35700f7">Share::genericAlignmenter</a> (T input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Generic number alignmenter. <a href="#g0bf9356c8f3e57840a77634de35700f7"></a><br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template<typename T> </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__backend.html#g0f1b9f81dfb6c7d9e490c7ae0b49e728">Share::alignmenter</a> (T input)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Number alignmenter using <code>BITS_ALIGNMENT</code> macro. <a href="#g0f1b9f81dfb6c7d9e490c7ae0b49e728"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="g29a6f4bde0ada26e8614a89d218da1a6"></a><!-- doxytag: member="DefaultAllocator.h::BITS_ALIGNMENT" ref="g29a6f4bde0ada26e8614a89d218da1a6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BITS_ALIGNMENT 8 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Define <b>memory</b> <b>alignment</b> in bits that allocator work with.
<p>
<dl class="attention" compact><dt><b>Attention:</b></dt><dd>This number could not be greater then OS's alignment used in SHM API </dd></dl>
<p>
Definition at line <a class="el" href="DefaultAllocator_8h-source.html#l00019">19</a> of file <a class="el" href="DefaultAllocator_8h-source.html">DefaultAllocator.h</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="g0f1b9f81dfb6c7d9e490c7ae0b49e728"></a><!-- doxytag: member="Share::alignmenter" ref="g0f1b9f81dfb6c7d9e490c7ae0b49e728" args="(T input)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T> </div>
<table class="memname">
<tr>
<td class="memname">T Share::alignmenter </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"> <em>input</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Number alignmenter using <code>BITS_ALIGNMENT</code> macro.
<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>input</em> </td><td>number to align </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>aligned number </dd></dl>
<p>
Definition at line <a class="el" href="DefaultAllocator_8h-source.html#l00048">48</a> of file <a class="el" href="DefaultAllocator_8h-source.html">DefaultAllocator.h</a>.
</div>
</div><p>
<a class="anchor" name="g0bf9356c8f3e57840a77634de35700f7"></a><!-- doxytag: member="Share::genericAlignmenter" ref="g0bf9356c8f3e57840a77634de35700f7" args="(T input)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<unsigned char bitsAlignment, typename T> </div>
<table class="memname">
<tr>
<td class="memname">T Share::genericAlignmenter </td>
<td>(</td>
<td class="paramtype">T </td>
<td class="paramname"> <em>input</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Generic number alignmenter.
<p>
Template parameter bitsAlignment specifies count of bits from end to align to. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>input</em> </td><td>number to align </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>aligned number </dd></dl>
<p>
Definition at line <a class="el" href="DefaultAllocator_8h-source.html#l00032">32</a> of file <a class="el" href="DefaultAllocator_8h-source.html">DefaultAllocator.h</a>.
</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__backend.html [Download]