IFIFOBuffer Class Reference

#include <IFIFOBuffer.h>

Inheritance diagram for IFIFOBuffer:

Inheritance graph
[legend]
List of all members.

Public Member Functions

 IFIFOBuffer (void)
virtual ~IFIFOBuffer (void)
virtual unsigned long read (unsigned char *outData, unsigned long inBytesToRead)=0
 Read bytes from the internal buffer. Returns how many actually read.
virtual unsigned long write (const unsigned char *inData, unsigned long inBytesToWrite)=0
 Write bytes into the internal buffer. Returns how many written.
virtual unsigned long numBytesAvail ()=0
 Returns how many bytes are available in the buffer.
virtual unsigned long spaceLeft ()=0
 Returns how much space is left in the buffer.
virtual void reset ()=0
 Resets the buffer.

Constructor & Destructor Documentation

IFIFOBuffer::IFIFOBuffer void   )  [inline]
 

Definition at line 36 of file IFIFOBuffer.h.

virtual IFIFOBuffer::~IFIFOBuffer void   )  [inline, virtual]
 

Definition at line 37 of file IFIFOBuffer.h.


Member Function Documentation

virtual unsigned long IFIFOBuffer::numBytesAvail  )  [pure virtual]
 

Returns how many bytes are available in the buffer.

Implemented in CircularBuffer.

Referenced by OggDataBuffer::numBytesAvail().

virtual unsigned long IFIFOBuffer::read unsigned char *  outData,
unsigned long  inBytesToRead
[pure virtual]
 

Read bytes from the internal buffer. Returns how many actually read.

Implemented in CircularBuffer.

Referenced by OggDataBuffer::processBaseHeader(), OggDataBuffer::processDataSegment(), and OggDataBuffer::processSegTable().

virtual void IFIFOBuffer::reset  )  [pure virtual]
 

Resets the buffer.

Implemented in CircularBuffer.

Referenced by OggDataBuffer::clearData().

virtual unsigned long IFIFOBuffer::spaceLeft  )  [pure virtual]
 

Returns how much space is left in the buffer.

Implemented in CircularBuffer.

virtual unsigned long IFIFOBuffer::write const unsigned char *  inData,
unsigned long  inBytesToWrite
[pure virtual]
 

Write bytes into the internal buffer. Returns how many written.

Implemented in CircularBuffer.

Referenced by OggDataBuffer::feed().


The documentation for this class was generated from the following file:
Generated on Tue Feb 15 15:03:20 2005 for oggdsf by  doxygen 1.3.9