class FixedBuffer

producer/consumer buffer for fixed size objects. More...

Definition#include <thread.h>
InheritsBuffer
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Members

Protected Members


Detailed Description

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

int OnPeek (void *buf)
[protected]

Return the first object in the buffer.

Parameters:
bufpointer to copy contents of head of buffer to.

Returns: predefined size of this buffers objects.

Reimplemented from Buffer

int OnWait (void *buf)
[protected]

Wait for and return a fixed object in the buffer.

Parameters:
bufpointer to hold object returned from the buffer.

Returns: predefined size of this buffers objects.

Reimplemented from Buffer

int OnPost (void *buf)
[protected]

Post an object of the appropriate size into the buffer.

Parameters:
bufpointer to data to copy into the buffer.

Returns: predefined size of this buffers objects.

Reimplemented from Buffer

FixedBuffer (size_t capacity, size_t objsize)

Create a buffer of known capacity for objects of a specified size.

Parameters:
capacityof the buffer.
objsizefor each object held in the buffer.

FixedBuffer (const FixedBuffer &fb)

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

Parameters:
fbexisting FixedBuffer object.

~FixedBuffer ()

Destroy the fixed buffer and free the memory used to store objects.