<!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>GNU CommonC++: ost::FixedBuffer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<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 class="current"><a href="annotated.html"><span>Classes</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 class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_fixed_buffer.html">FixedBuffer</a>
</div>
</div>
<div class="contents">
<h1>ost::FixedBuffer Class Reference</h1><!-- doxytag: class="ost::FixedBuffer" --><!-- doxytag: inherits="ost::Buffer" -->
<p>A buffer class that holds a known capacity of fixed sized objects defined during creation.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="buffer_8h_source.html">buffer.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ost::FixedBuffer:</div>
<div class="dynsection">
<div class="center">
<img src="classost_1_1_fixed_buffer.png" usemap="#ost::FixedBuffer_map" alt=""/>
<map id="ost::FixedBuffer_map" name="ost::FixedBuffer_map">
<area href="classost_1_1_buffer.html" alt="ost::Buffer" shape="rect" coords="0,56,100,80"/>
<area href="classost_1_1_conditional.html" alt="ost::Conditional" shape="rect" coords="0,0,100,24"/>
</map>
</div>
</div>
<p><a href="classost_1_1_fixed_buffer-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_fixed_buffer.html#a154d01f4960fabb6d0310a33290e3e96">FixedBuffer</a> (size_t capacity, size_t objsize)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a buffer of known capacity for objects of a specified size. <a href="#a154d01f4960fabb6d0310a33290e3e96"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_fixed_buffer.html#abee76b72fa800332666f57e6f62fc551">FixedBuffer</a> (const <a class="el" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> &fb)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a copy of an existing fixed size buffer and duplicate it's contents. <a href="#abee76b72fa800332666f57e6f62fc551"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_fixed_buffer.html#a70f1e3b40a36ed683d9d2d08e5e8d14f">~FixedBuffer</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the fixed buffer and free the memory used to store objects. <a href="#a70f1e3b40a36ed683d9d2d08e5e8d14f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_fixed_buffer.html#a5cba81d3c87bb5defc162bea91fba442">operator=</a> (const <a class="el" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> &fb)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_fixed_buffer.html#a0a374a1a50ae78ce64db9e4ab25991d2">isValid</a> (void)</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_fixed_buffer.html#ae0a0b8dcb25e97313de5b998e1f22bfd">onPeek</a> (void *buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the first object in the buffer. <a href="#ae0a0b8dcb25e97313de5b998e1f22bfd"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_fixed_buffer.html#a8364661c1b2d2114d87be12479b04a47">onWait</a> (void *buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait for and return a fixed object in the buffer. <a href="#a8364661c1b2d2114d87be12479b04a47"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_fixed_buffer.html#a5d39b3282dd4a18d79456f7f16962b35">onPost</a> (void *buf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Post an object of the appropriate size into the buffer. <a href="#a5d39b3282dd4a18d79456f7f16962b35"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A buffer class that holds a known capacity of fixed sized objects defined during creation. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> producer/consumer buffer for fixed size objects. </dd></dl>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a154d01f4960fabb6d0310a33290e3e96"></a><!-- doxytag: member="ost::FixedBuffer::FixedBuffer" ref="a154d01f4960fabb6d0310a33290e3e96" args="(size_t capacity, size_t objsize)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::FixedBuffer::FixedBuffer </td>
<td>(</td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>capacity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"> <em>objsize</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a buffer of known capacity for objects of a specified size. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>capacity</em> </td><td>of the buffer. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>objsize</em> </td><td>for each object held in the buffer. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="abee76b72fa800332666f57e6f62fc551"></a><!-- doxytag: member="ost::FixedBuffer::FixedBuffer" ref="abee76b72fa800332666f57e6f62fc551" args="(const FixedBuffer &fb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::FixedBuffer::FixedBuffer </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> & </td>
<td class="paramname"> <em>fb</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Create a copy of an existing fixed size buffer and duplicate it's contents. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>fb</em> </td><td>existing <a class="el" href="classost_1_1_fixed_buffer.html" title="A buffer class that holds a known capacity of fixed sized objects defined during...">FixedBuffer</a> object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a70f1e3b40a36ed683d9d2d08e5e8d14f"></a><!-- doxytag: member="ost::FixedBuffer::~FixedBuffer" ref="a70f1e3b40a36ed683d9d2d08e5e8d14f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ost::FixedBuffer::~FixedBuffer </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destroy the fixed buffer and free the memory used to store objects. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a0a374a1a50ae78ce64db9e4ab25991d2"></a><!-- doxytag: member="ost::FixedBuffer::isValid" ref="a0a374a1a50ae78ce64db9e4ab25991d2" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::FixedBuffer::isValid </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classost_1_1_buffer.html#a255237cf9eebf6010546e884933ff8ba">ost::Buffer</a>.</p>
</div>
</div>
<a class="anchor" id="ae0a0b8dcb25e97313de5b998e1f22bfd"></a><!-- doxytag: member="ost::FixedBuffer::onPeek" ref="ae0a0b8dcb25e97313de5b998e1f22bfd" args="(void *buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::FixedBuffer::onPeek </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Return the first object in the buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>predefined size of this buffers objects. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to copy contents of head of buffer to. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classost_1_1_buffer.html#a5879caf00bd75cd972d84b822cb77ef0">ost::Buffer</a>.</p>
</div>
</div>
<a class="anchor" id="a5d39b3282dd4a18d79456f7f16962b35"></a><!-- doxytag: member="ost::FixedBuffer::onPost" ref="a5d39b3282dd4a18d79456f7f16962b35" args="(void *buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::FixedBuffer::onPost </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Post an object of the appropriate size into the buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>predefined size of this buffers objects. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to data to copy into the buffer. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classost_1_1_buffer.html#a7ee3158e74f0e50e91f14bf370feb1fa">ost::Buffer</a>.</p>
</div>
</div>
<a class="anchor" id="a8364661c1b2d2114d87be12479b04a47"></a><!-- doxytag: member="ost::FixedBuffer::onWait" ref="a8364661c1b2d2114d87be12479b04a47" args="(void *buf)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t ost::FixedBuffer::onWait </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"> <em>buf</em></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait for and return a fixed object in the buffer. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>predefined size of this buffers objects. </dd></dl>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>pointer to hold object returned from the buffer. </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="classost_1_1_buffer.html#a9662e8def92667057121de0847dcabf0">ost::Buffer</a>.</p>
</div>
</div>
<a class="anchor" id="a5cba81d3c87bb5defc162bea91fba442"></a><!-- doxytag: member="ost::FixedBuffer::operator=" ref="a5cba81d3c87bb5defc162bea91fba442" args="(const FixedBuffer &fb)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classost_1_1_fixed_buffer.html">FixedBuffer</a>& ost::FixedBuffer::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> & </td>
<td class="paramname"> <em>fb</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="buffer_8h_source.html">buffer.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:57:39 2010 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.1
>
x86_64
>
media
>
main-updates
>
by-pkgid
>
f36f42783f75191f5f2d47f1e8c5504e
>
files
>
167
