Main Page   Class Hierarchy   Compound List   File List   Compound Members  

dbBlobIterator Class Reference

#include <blob.h>

Inheritance diagram for dbBlobIterator:

dbBlobReadIterator List of all members.

Public Methods

virtual size_t getAvailableSize ()=0
size_t getAvailableBufferSize ()
virtual void * mapBuffer ()=0
virtual void unmapBuffer (size_t proceeded)
virtual void close ()
 dbBlobIterator (dbDatabase &db, oid_t oid)
virtual ~dbBlobIterator ()

Detailed Description

Large binary object iterator. BLOB consist of several linked BLOB segments. BLOB iterator performs traversal through all thoses segments.


Constructor & Destructor Documentation

dbBlobIterator::dbBlobIterator dbDatabase   db,
oid_t    oid
 

BLOB iterator constructor

Parameters:
db  reference to the database
oid  object identifier of BLOB

virtual dbBlobIterator::~dbBlobIterator   [virtual]
 

BLOB destructor


Member Function Documentation

virtual void dbBlobIterator::close   [virtual]
 

Close BLOB iterator

Reimplemented in dbBlobReadIterator.

size_t dbBlobIterator::getAvailableBufferSize   [inline]
 

Get size of available BLOB buffer. This method should be invoked after mapBuffer().

Returns:
number of bytes which can be directly written to the BLOB.

virtual size_t dbBlobIterator::getAvailableSize   [pure virtual]
 

Get size of sequential BLOB segment

Returns:
number of bytes which is available to read/write in current BLOB segment. If this method return 0, it means that end of BLOB is reached.

Implemented in dbBlobReadIterator.

virtual void* dbBlobIterator::mapBuffer   [pure virtual]
 

Map current BLOB buffer to the memory, allowing direct access (read or write) to the buffer

Returns:
pointer to the buffer

Implemented in dbBlobReadIterator.

virtual void dbBlobIterator::unmapBuffer size_t    proceeded [virtual]
 

Release BLOB buffer

Parameters:
proceeded  number of proceeded (read or write) bytes


The documentation for this class was generated from the following file:
Generated on Thu Aug 23 19:35:52 2007 for GigaBASE by doxygen1.2.18