A buffer class that holds a known capacity of fixed sized objects defined during creation. More...

#include <thread.h>

Inheritance diagram for ost::FixedBuffer:

Collaboration diagram for ost::FixedBuffer:

Public Member Functions
	FixedBuffer (size_t capacity, size_t objsize)
	Create a buffer of known capacity for objects of a specified size.
	FixedBuffer (FixedBuffer &fb)
	Create a copy of an existing fixed size buffer and duplicate it's contents.
bool	isValid (void)
	New virtual to test if buffer is a valid object.
FixedBuffer &	operator= (FixedBuffer &fb)
virtual	~FixedBuffer ()
	Destroy the fixed buffer and free the memory used to store objects.
Protected Member Functions
size_t	onPeek (void *buf)
	Return the first object in the buffer.
size_t	onPost (void *buf)
	Post an object of the appropriate size into the buffer.
size_t	onWait (void *buf)
	Wait for and return a fixed object in the buffer.

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.

Definition at line 708 of file thread.h.

Constructor & Destructor Documentation

ost::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.

ost::FixedBuffer::FixedBuffer ( FixedBuffer & fb )

Create a copy of an existing fixed size buffer and duplicate it's contents.

Parameters:

fb	existing FixedBuffer object.

bool ost::FixedBuffer::isValid ( void ) [virtual]

New virtual to test if buffer is a valid object.

Reimplemented from ost::Buffer.

size_t ost::FixedBuffer::onPeek ( void * buf ) [protected, virtual]

Return the first object in the buffer.

Parameters:

buf	pointer to copy contents of head of buffer to.

Implements ost::Buffer.

size_t ost::FixedBuffer::onPost ( void * buf ) [protected, virtual]

Post an object of the appropriate size into the buffer.

Parameters:

buf	pointer to data to copy into the buffer.

Implements ost::Buffer.

size_t ost::FixedBuffer::onWait ( void * buf ) [protected, virtual]

Wait for and return a fixed object in the buffer.

Parameters:

buf	pointer to hold object returned from the buffer.

Implements ost::Buffer.

The documentation for this class was generated from the following file: