DOKK / manpages / debian 11 / libcommoncpp2-doc / ost_FixedBuffer.3.en
ost::FixedBuffer(3) Library Functions Manual ost::FixedBuffer(3)

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

#include <buffer.h>

Inherits ost::Buffer.


FixedBuffer (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)


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.

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.

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.

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

Parameters

fb existing FixedBuffer object.

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

Reimplemented from ost::Buffer.

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.

Implements ost::Buffer.

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.

Implements ost::Buffer.

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.

Implements ost::Buffer.

FixedBuffer& ost::FixedBuffer::operator= (const FixedBuffer & fb)

Generated automatically by Doxygen for GNU CommonC++ from the source code.

Sun Dec 27 2020 GNU CommonC++