<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ost::FixedBuffer class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.10 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>ost::FixedBuffer Class Reference</h1>A buffer class that holds a known capacity of fixed sized objects defined during creation. producer/consumer buffer for fixed size objects.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="thread_8h-source.html">thread.h</a>></code>
<p>
<p>Inheritance diagram for ost::FixedBuffer::
<p><center><img src="classost_1_1_fixed_buffer.gif" usemap="#ost::FixedBuffer_map" border="0"></center>
<map name="ost::FixedBuffer_map">
<area href="classost_1_1_buffer.html" alt="ost::Buffer" shape="rect" coords="0,0,100,24">
</map>
<a href="classost_1_1_fixed_buffer-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classost_1_1_fixed_buffer.html#a0">FixedBuffer</a> (size_t capacity, size_t objsize)</td></tr>
<tr><td> </td><td><font size=-1><em>Create a buffer of known capacity for objects of a specified size.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classost_1_1_fixed_buffer.html#a1">FixedBuffer</a> (const FixedBuffer &fb)</td></tr>
<tr><td> </td><td><font size=-1><em>Create a copy of an existing fixed size buffer and duplicate it's contents.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classost_1_1_fixed_buffer.html#a2">~FixedBuffer</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Destroy the fixed buffer and free the memory used to store objects.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>FixedBuffer & </td><td valign=bottom><a class="el" href="classost_1_1_fixed_buffer.html#a3">operator=</a> (const FixedBuffer &fb)</td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classost_1_1_fixed_buffer.html#a4">isValid</a> (void)</td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classost_1_1_fixed_buffer.html#b0">OnPeek</a> (void *buf)</td></tr>
<tr><td> </td><td><font size=-1><em>Return the first object in the buffer.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classost_1_1_fixed_buffer.html#b1">OnWait</a> (void *buf)</td></tr>
<tr><td> </td><td><font size=-1><em>Wait for and return a fixed object in the buffer.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classost_1_1_fixed_buffer.html#b2">OnPost</a> (void *buf)</td></tr>
<tr><td> </td><td><font size=-1><em>Post an object of the appropriate size into the buffer.</em> <a href="#b2">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A buffer class that holds a known capacity of fixed sized objects defined during creation. producer/consumer buffer for fixed size objects.
<p>
<dl compact><dt><b>
Author: </b><dd>
David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="a0" doxytag="ost::FixedBuffer::FixedBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ost::FixedBuffer::FixedBuffer </td>
<td class="md">( </td>
<td class="md">size_t</td>
<td class="mdname"> <em>capacity</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">size_t</td>
<td class="mdname"> <em>objsize</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a buffer of known capacity for objects of a specified size.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>capacity
</em> </td><td>
of the buffer. </td></tr>
<tr><td valign=top><em>objsize
</em> </td><td>
for each object held in the buffer. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="ost::FixedBuffer::FixedBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ost::FixedBuffer::FixedBuffer </td>
<td class="md">( </td>
<td class="md">const FixedBuffer &</td>
<td class="mdname1"> <em>fb</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Create a copy of an existing fixed size buffer and duplicate it's contents.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>fb
</em> </td><td>
existing <a class="el" href="classost_1_1_fixed_buffer.html">FixedBuffer</a> object. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="ost::FixedBuffer::~FixedBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual ost::FixedBuffer::~FixedBuffer </td>
<td class="md">( </td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Destroy the fixed buffer and free the memory used to store objects.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b0" doxytag="ost::FixedBuffer::OnPeek"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ost::FixedBuffer::OnPeek </td>
<td class="md">( </td>
<td class="md">void *</td>
<td class="mdname1"> <em>buf</em> </td>
<td class="md">) </td>
<td class="md"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Return the first object in the buffer.
<p>
<dl compact><dt><b>
Returns: </b><dd>
predefined size of this buffers objects. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>buf
</em> </td><td>
pointer to copy contents of head of buffer to. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classost_1_1_buffer.html#b0">ost::Buffer</a>. </td>
</tr>
</table>
<a name="b2" doxytag="ost::FixedBuffer::OnPost"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ost::FixedBuffer::OnPost </td>
<td class="md">( </td>
<td class="md">void *</td>
<td class="mdname1"> <em>buf</em> </td>
<td class="md">) </td>
<td class="md"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Post an object of the appropriate size into the buffer.
<p>
<dl compact><dt><b>
Returns: </b><dd>
predefined size of this buffers objects. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>buf
</em> </td><td>
pointer to data to copy into the buffer. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classost_1_1_buffer.html#b2">ost::Buffer</a>. </td>
</tr>
</table>
<a name="b1" doxytag="ost::FixedBuffer::OnWait"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ost::FixedBuffer::OnWait </td>
<td class="md">( </td>
<td class="md">void *</td>
<td class="mdname1"> <em>buf</em> </td>
<td class="md">) </td>
<td class="md"><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Wait for and return a fixed object in the buffer.
<p>
<dl compact><dt><b>
Returns: </b><dd>
predefined size of this buffers objects. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>buf
</em> </td><td>
pointer to hold object returned from the buffer. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classost_1_1_buffer.html#b1">ost::Buffer</a>. </td>
</tr>
</table>
<a name="a4" doxytag="ost::FixedBuffer::isValid"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> bool ost::FixedBuffer::isValid </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_buffer.html#a7">ost::Buffer</a>. </td>
</tr>
</table>
<a name="a3" doxytag="ost::FixedBuffer::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> FixedBuffer& ost::FixedBuffer::operator= </td>
<td class="md">( </td>
<td class="md">const FixedBuffer &</td>
<td class="mdname1"> <em>fb</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="thread_8h-source.html">thread.h</a></ul>
<hr><address><small>Generated at Fri Jan 4 18:51:49 2002 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
68d373e54fb21da3730c08bede406633
>
files
>
548
