XspfChunkCallback Class Reference

#include <XspfChunkCallback.h>

List of all members.

Protected Member Functions

 XspfChunkCallback ()
 XspfChunkCallback (XspfChunkCallback const &source)
XspfChunkCallback & operator= (XspfChunkCallback const &source)
virtual ~XspfChunkCallback ()
virtual int getMinimumBufferByteSize ()=0
virtual int fillBuffer (void *buffer)=0
virtual void notifyStop ()

Friends

class XspfReader


Detailed Description

Hands out text chunks to a XspfReader. This enables parsing from non-linear input structures. It can also be used to parse bug XSPF files in smaller chunks to lower memory usage.

Definition at line 63 of file XspfChunkCallback.h.


Constructor & Destructor Documentation

XspfChunkCallback (  )  [protected]

Creates a new chunk callback.

XspfChunkCallback ( XspfChunkCallback const &  source  )  [protected]

Copy constructor.

Parameters:
source Source to copy from

virtual ~XspfChunkCallback (  )  [protected, virtual]

Destroys this chunk callback.


Member Function Documentation

XspfChunkCallback& operator= ( XspfChunkCallback const &  source  )  [protected]

Assignment operator.

Parameters:
source Source to copy from

virtual int getMinimumBufferByteSize (  )  [protected, pure virtual]

Returns the minimum size in bytes of the buffer handed to fillBuffer in a subsequent call.

Returns:
Size in bytes

virtual int fillBuffer ( void *  buffer  )  [protected, pure virtual]

Fulls buffer with a new chunk of input. the chunk copies must not exceed the number of bytes returned by the last call to getMinimumBufferByteSize. NOTE: You do not have to zero-terminate the string written. If you do so do not count this into the return value.

Parameters:
buffer Buffer to write to
Returns:
Number of bytes actually written

virtual void notifyStop (  )  [protected, virtual]

Notifies this chunk callback, that no more chunks will be needed. You can close the resource read from in here.


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

Generated on Sat Mar 7 15:40:21 2009 for libxspf by  doxygen 1.5.6