|
Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members
FixedBuffer Class ReferenceA buffer class that holds a known capacity of fixed sized objects defined during creation. producer/consumer buffer for fixed size objects.
More...
#include <thread.h>
Inheritance diagram for FixedBuffer:
List of all members.
Public Methods |
| FixedBuffer (size_t capacity, size_t objsize) |
| Create a buffer of known capacity for objects of a specified size. More...
|
| FixedBuffer (const FixedBuffer &fb) |
| Create a copy of an existing fixed size buffer and duplicate it's contents. More...
|
| ~FixedBuffer () |
| Destroy the fixed buffer and free the memory used to store objects.
|
FixedBuffer& | operator= (const FixedBuffer &fb) |
bool | isValid (void) |
Protected Methods |
int | OnPeek (void *buf) |
| Return the first object in the buffer. More...
|
int | OnWait (void *buf) |
| Wait for and return a fixed object in the buffer. More...
|
int | OnPost (void *buf) |
| Post an object of the appropriate size into the buffer. More...
|
Detailed Description
A buffer class that holds a known capacity of fixed sized objects defined during creation. producer/consumer buffer for fixed size objects.
-
Author(s):
-
David Sugar <dyfet@ostel.com>
Constructor & Destructor Documentation
FixedBuffer::FixedBuffer (
|
size_t capacity,
|
|
size_t objsize )
|
|
|
Create a buffer of known capacity for objects of a specified size.
-
Parameters:
-
capacity
|
of the buffer. |
objsize
|
for each object held in the buffer. |
|
FixedBuffer::FixedBuffer (
|
const FixedBuffer & fb )
|
|
|
Create a copy of an existing fixed size buffer and duplicate it's contents.
-
Parameters:
-
fb
|
existing FixedBuffer object. |
|
FixedBuffer::~FixedBuffer (
|
)
|
|
|
Destroy the fixed buffer and free the memory used to store objects.
|
Member Function Documentation
int FixedBuffer::OnPeek (
|
void * buf ) [protected, virtual]
|
|
|
Return the first object in the buffer.
-
Returns:
-
predefined size of this buffers objects.
-
Parameters:
-
buf
|
pointer to copy contents of head of buffer to. |
Reimplemented from Buffer. |
int FixedBuffer::OnPost (
|
void * buf ) [protected, virtual]
|
|
|
Post an object of the appropriate size into the buffer.
-
Returns:
-
predefined size of this buffers objects.
-
Parameters:
-
buf
|
pointer to data to copy into the buffer. |
Reimplemented from Buffer. |
int FixedBuffer::OnWait (
|
void * buf ) [protected, virtual]
|
|
|
Wait for and return a fixed object in the buffer.
-
Returns:
-
predefined size of this buffers objects.
-
Parameters:
-
buf
|
pointer to hold object returned from the buffer. |
Reimplemented from Buffer. |
bool FixedBuffer::isValid (
|
void ) [virtual]
|
|
FixedBuffer& FixedBuffer::operator= (
|
const FixedBuffer & fb )
|
|
The documentation for this class was generated from the following file:
Generated at Fri Mar 23 10:47:55 2001 for CommonC++ by
1.2.1 written by Dimitri van Heesch,
© 1997-2000
|