DurableIterator Class Reference

#include <DurableIterator.h>

Inheritance diagram for DurableIterator:

DurableFilterIterator< _filter > List of all members.

Detailed Description

Abstract base class for a table iterator.

Note: It is important that iterators do NOT outlive the tables they point into.

Definition at line 28 of file DurableIterator.h.

Public Member Functions

virtual ~DurableIterator ()
virtual int next ()=0
 Advance the pointer.
virtual int get_key (SerializableObject *key)=0
 Unserialize the current element into the given key object.


Constructor & Destructor Documentation

virtual DurableIterator::~DurableIterator (  )  [inline, virtual]

Definition at line 31 of file DurableIterator.h.


Member Function Documentation

virtual int DurableIterator::next (  )  [pure virtual]

Advance the pointer.

An initialized iterator will be pointing right before the first element in the list, so iteration code will always be:

 MyKeyType key;
 DurableIterator* i = table->itr();
 while (i->next() == 0) 
 {
    i->get(&key);
    // ... do stuff
 }
 
 // Remember to delete the Iterator! Bad things happen if the
 table disappears when the iterator is still open.
 delete_z(i);

Returns:
DS_OK, DS_NOTFOUND if no more elements, DS_ERR if an error occurred while iterating.

Implemented in DurableFilterIterator< _filter >.

Referenced by DurableFilterIterator< _filter >::next().

virtual int DurableIterator::get_key ( SerializableObject *  key  )  [pure virtual]

Unserialize the current element into the given key object.

Implemented in DurableFilterIterator< _filter >.

Referenced by DurableFilterIterator< _filter >::get_key().


The documentation for this class was generated from the following file:
Generated on Thu Jun 7 12:54:31 2007 for DTN Reference Implementation by  doxygen 1.5.1