ost::FixedBuffer - A buffer class that holds a known capacity of fixed sized objects defined during
Contents
Constructor & Destructor Documentation
ost::FixedBuffer::FixedBuffer(size_tcapacity,size_tobjsize)
Create a buffer of known capacity for objects of a specified size.
Parameterscapacity of the buffer.
objsize for each object held in the buffer.
ost::FixedBuffer::FixedBuffer(constFixedBuffer&fb)
Create a copy of an existing fixed size buffer and duplicate it's contents.
Parametersfb existing FixedBuffer object.
virtualost::FixedBuffer::~FixedBuffer()[virtual]
Destroy the fixed buffer and free the memory used to store objects.
Detailed Description
A buffer class that holds a known capacity of fixed sized objects defined during creation.
Author
David Sugar dyfet@ostel.com
producer/consumer buffer for fixed size objects.
Member Function Documentation
boolost::FixedBuffer::isValid(void)[virtual]
Reimplemented from ost::Buffer.
size_tost::FixedBuffer::onPeek(void*buf)[protected],[virtual]
Return the first object in the buffer.
Returns
predefined size of this buffers objects.
Parametersbuf pointer to copy contents of head of buffer to.
Implements ost::Buffer.
size_tost::FixedBuffer::onPost(void*buf)[protected],[virtual]
Post an object of the appropriate size into the buffer.
Returns
predefined size of this buffers objects.
Parametersbuf pointer to data to copy into the buffer.
Implements ost::Buffer.
size_tost::FixedBuffer::onWait(void*buf)[protected],[virtual]
Wait for and return a fixed object in the buffer.
Returns
predefined size of this buffers objects.
Parametersbuf pointer to hold object returned from the buffer.
Implements ost::Buffer.
FixedBuffer&ost::FixedBuffer::operator=(constFixedBuffer&fb)Name
ost::FixedBuffer - A buffer class that holds a known capacity of fixed sized objects defined during
creation.
Synopsis
#include <buffer.h>
Inherits ost::Buffer.
PublicMemberFunctionsFixedBuffer (size_t capacity, size_t objsize)
Create a buffer of known capacity for objects of a specified size.
FixedBuffer (const FixedBuffer &fb)
Create a copy of an existing fixed size buffer and duplicate it's contents.
virtual ~FixedBuffer ()
Destroy the fixed buffer and free the memory used to store objects.
FixedBuffer & operator= (const FixedBuffer &fb)
bool isValid (void)
ProtectedMemberFunctions
size_t onPeek (void *buf)
Return the first object in the buffer.
size_t onWait (void *buf)
Wait for and return a fixed object in the buffer.
size_t onPost (void *buf)
Post an object of the appropriate size into the buffer.
AdditionalInheritedMembers