ost_fixedbuffer(3) [debian man page]
ost::FixedBuffer(3) Library Functions Manual ost::FixedBuffer(3) 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. Public Member Functions 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) Protected Member Functions 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. Additional Inherited Members 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. Constructor &; Destructor Documentation ost::FixedBuffer::FixedBuffer (size_tcapacity, size_tobjsize) 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 (const FixedBuffer &fb) Create a copy of an existing fixed size buffer and duplicate it's contents. Parameters: fb existing FixedBuffer object. virtual ost::FixedBuffer::~FixedBuffer () [virtual] Destroy the fixed buffer and free the memory used to store objects. Member Function Documentation bool ost::FixedBuffer::isValid (void) [virtual] Reimplemented from ost::Buffer. size_t ost::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. Implements ost::Buffer. size_t ost::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. Implements ost::Buffer. size_t ost::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. Implements ost::Buffer. FixedBuffer& ost::FixedBuffer::operator= (const FixedBuffer &fb) Author Generated automatically by Doxygen for GNU CommonC++ from the source code. GNU CommonC++ Sat Jun 23 2012 ost::FixedBuffer(3)
Check Out this Related Man Page
ost::Number(3) Library Functions Manual ost::Number(3) NAME
ost::Number - A number manipulation class. SYNOPSIS
#include <numbers.h> Inherited by ost::DateNumber, and ost::ZNumber. Public Member Functions Number (char *buffer, unsigned size) Create an instance of a number. void setValue (long value) const char * getBuffer () const long getValue () const long operator() () operator long () operator char * () long operator= (const long value) long operator+= (const long value) long operator-= (const long value) long operator-- () long operator++ () int operator== (const Number &num) int operator!= (const Number &num) int operator< (const Number &num) int operator<= (const Number &num) int operator> (const Number &num) int operator>= (const Number &num) Protected Attributes char * buffer unsigned size Friends long operator+ (const Number &num, const long val) long operator+ (const long val, const Number &num) long operator- (const Number &num, long val) long operator- (const long val, const Number &num) Detailed Description A number manipulation class. This is used to extract, convert, and manage simple numbers that are represented in C ascii strings in a very quick and optimal way. Author: David Sugar dyfet@ostel.com number manipulation. Constructor &; Destructor Documentation ost::Number::Number (char *buffer, unsignedsize) Create an instance of a number. Parameters: buffer or NULL if created internally. size use - values for zero filled. Member Function Documentation const char* ost::Number::getBuffer () const [inline] long ost::Number::getValue () const ost::Number::operator char * () [inline] ost::Number::operator long () [inline] int ost::Number::operator!= (const Number &num) long ost::Number::operator() () [inline] long ost::Number::operator++ () long ost::Number::operator+= (const longvalue) long ost::Number::operator-- () long ost::Number::operator-= (const longvalue) int ost::Number::operator< (const Number &num) int ost::Number::operator<= (const Number &num) long ost::Number::operator= (const longvalue) Reimplemented in ost::ZNumber. int ost::Number::operator== (const Number &num) int ost::Number::operator> (const Number &num) int ost::Number::operator>= (const Number &num) void ost::Number::setValue (longvalue) Reimplemented in ost::ZNumber. Friends And Related Function Documentation long operator+ (const Number &num, const longval) [friend] long operator+ (const longval, const Number &num) [friend] long operator- (const Number &num, longval) [friend] long operator- (const longval, const Number &num) [friend] Member Data Documentation char* ost::Number::buffer [protected] unsigned ost::Number::size [protected] Author Generated automatically by Doxygen for GNU CommonC++ from the source code. GNU CommonC++ Sat Jun 23 2012 ost::Number(3)