PersistentStore.h

00001 // Copyright 2008 Michael Marsh, University of Maryland.
00002 //
00003 // This file is part of pydtn.
00004 //
00005 // pydtn is free software: you can redistribute it and/or modify
00006 // it under the terms of the GNU General Public License as published by
00007 // the Free Software Foundation, either version 3 of the License, or
00008 // (at your option) any later version.
00009 //
00010 // pydtn is distributed in the hope that it will be useful,
00011 // but WITHOUT ANY WARRANTY; without even the implied warranty of
00012 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00013 // GNU General Public License for more details.
00014 //
00015 // You should have received a copy of the GNU General Public License
00016 // along with pydtn.  If not, see <http://www.gnu.org/licenses/>.
00017 //
00018 // The views and conclusions contained in the software and documentation
00019 // are those of the authors and should not be interpreted as representing
00020 // official policies, either expressed or implied, of the University
00021 // of Maryland.
00022 //
00023 // pydtn extends and embeds the Python interpreter, which is
00024 // Copyright 2001-2006 Python Software Foundation, All Rights Reserved,
00025 // and is released under the PSF License Agreement.
00026 //
00027 // RANLUX random number generation uses the Boost library,
00028 // Copyright 1994-2006 by various authors (details in individual files),
00029 // which is released under the Boost Software License, Version 1.0.
00030 
00031 #ifndef __WRAPPERS_HARNESS_PERSISTENT_STORE_H__
00032 #define __WRAPPERS_HARNESS_PERSISTENT_STORE_H__
00033 
00034 #include "config.h"
00035 
00036 #include "simlpy/Time.h"
00037 #include "dtn/PersistentBundleStore.h"
00038 #include "dtn/ByteString.h"
00039 #include <set>
00040 
00041 class WrapNode;
00042 
00045 
00047 class PersistentBundle
00048 {
00049    public :
00051       PersistentBundle( DTN::Bundle* b );
00053       PersistentBundle( const DTN::ByteString& originator, uint32_t seqNum );
00055       virtual ~PersistentBundle();
00056 
00058       DTN::Bundle* bundle() const;
00059 
00062       bool operator<( const PersistentBundle& b ) const;
00063 
00065       const Time& timeAdded() const { return m_timeAdded; }
00066 
00067    private :
00068       DTN::Bundle*     m_bundle;
00069       DTN::ByteString  m_originator;
00070       uint32_t         m_seqNum;
00071       Time             m_timeAdded;
00072       Time             m_timeSent;
00073       unsigned int     m_numTries;
00074 };
00075 
00077 class PersistentStore : public DTN::PersistentBundleStore
00078 {
00079    public :
00081       typedef std::set< PersistentBundle >  BundleList;
00083       typedef BundleList::key_type          key_type;
00084 
00086       PersistentStore( WrapNode* owner );
00088       virtual ~PersistentStore();
00089 
00091       BundleList::iterator begin();
00096       BundleList::iterator lower_bound( const key_type& x );
00100       BundleList::iterator upper_bound( const key_type& x );
00102       BundleList::iterator end();
00103 
00105       BundleList::const_iterator begin() const;
00110       BundleList::const_iterator lower_bound( const key_type& x ) const;
00114       BundleList::const_iterator upper_bound( const key_type& x ) const;
00116       BundleList::const_iterator end() const;
00117 
00118    protected :
00123       virtual DTN::BundlePointer p_addBundle( DTN::Bundle* b );
00126       virtual void p_deleteBundle( DTN::Bundle* b );
00127 
00136       virtual DTN::BundlePointer p_getPointer( const DTN::BundlePointer& p );
00137 
00147       virtual DTN::BundlePointer p_getPointer( const DTN::ByteString& sender,
00148                                                uint32_t seqNum );
00149 
00155       virtual bool p_validatePointer( const DTN::BundlePointer& p );
00156 
00160       virtual size_t p_bytesUsed() { return m_bytesUsed; }
00161 
00165       virtual size_t p_bundles() { return m_list.size(); }
00166 
00170       virtual void p_shrinkStore( size_t s );
00171 
00172    private :
00173       BundleList  m_list;
00174       size_t      m_bytesUsed;
00175       WrapNode*   m_wowner;
00176 };
00177 
00179 class PersistentStoreItr : public DTN::BundlePointerRepr
00180 {
00181    public :
00185       PersistentStoreItr( PersistentStore& store,
00186                           PersistentStore::BundleList::iterator itr );
00188       virtual ~PersistentStoreItr();
00189 
00194       virtual bool operator==( const DTN::BundlePointerRepr& b );
00195 
00203       virtual DTN::BundlePointerRepr* next();
00204 
00211       virtual DTN::BundlePointerRepr* clone();
00212 
00224       virtual DTN::Bundle* bundle() const;
00225 
00226    private :
00227       PersistentStore&                       m_store;
00228       PersistentStore::BundleList::iterator  m_itr;
00229 };
00230 
00232 
00233 #endif /* __WRAPPERS_HARNESS_PERSISTENT_STORE_H__ */

Generated on Mon Mar 24 11:15:46 2008 for Pydtn Simulator by  doxygen 1.5.4