EpidemicStore.h

// Copyright 2008 Michael Marsh, University of Maryland.
//
// This file is part of pydtn.
//
// pydtn is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// pydtn is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with pydtn.  If not, see <http://www.gnu.org/licenses/>.
//
// The views and conclusions contained in the software and documentation
// are those of the authors and should not be interpreted as representing
// official policies, either expressed or implied, of the University
// of Maryland.
//
// pydtn extends and embeds the Python interpreter, which is
// Copyright 2001-2006 Python Software Foundation, All Rights Reserved,
// and is released under the PSF License Agreement.
//
// RANLUX random number generation uses the Boost library,
// Copyright 1994-2006 by various authors (details in individual files),
// which is released under the Boost Software License, Version 1.0.

#ifndef __EPIDEMIC_EPIDEMIC_STORE_H__
#define __EPIDEMIC_EPIDEMIC_STORE_H__

#include "config.h"

#include "simlpy/Time.h"
#include "dtn/PersistentBundleStore.h"
#include "dtn/ByteString.h"
#include "dtn/Node.h"
#include <set>
#include <map>
#include <list>

class WrapNode;


namespace Epidemic
{

   class EpidemicBundle
   {
      public :
         EpidemicBundle( DTN::Bundle* b );
         EpidemicBundle( const DTN::ByteString& originator, uint32_t seqNum );
         EpidemicBundle( const DTN::ByteString& digest );
         virtual ~EpidemicBundle();

         DTN::Bundle* bundle() const;

         bool operator<( const EpidemicBundle& b ) const;

         const Time& timeAdded() const { return m_timeAdded; }

         const DTN::ByteString& digest() const { return m_digest; }

      private :
         DTN::Bundle*     m_bundle;
         DTN::ByteString  m_originator;
         uint32_t         m_seqNum;
         Time             m_timeAdded;
         Time             m_timeSent;
         unsigned int     m_numTries;
         DTN::ByteString  m_digest;
   };

   class EpidemicStore : public DTN::PersistentBundleStore
   {
      public :
         typedef std::set< EpidemicBundle >  BundleList;
         typedef BundleList::key_type        key_type;
         typedef BundleList::iterator        iterator;
         typedef BundleList::const_iterator  const_iterator;

         typedef std::map< DTN::ByteString , iterator >  DigestMap;
         typedef std::list< iterator > DestList;
         typedef std::map< DTN::ByteString , DestList >  DestMap;
         typedef std::set< DTN::ByteString >  HistorySet;
         typedef std::list< DTN::ByteString >  DigestList;

         EpidemicStore( DTN::Node* owner, uint32_t h = 0 );
         virtual ~EpidemicStore();

         virtual void consume( DTN::Bundle* b );

         DTN::BundlePointer getPointer( const DTN::ByteString& digest );

         iterator begin();
         iterator lower_bound( const key_type& x );
         iterator upper_bound( const key_type& x );
         iterator end();

         const_iterator begin() const;
         const_iterator lower_bound( const key_type& x ) const;
         const_iterator upper_bound( const key_type& x ) const;
         const_iterator end() const;

         DTN::ByteString* summaryVector() const;

         static DTN::ByteString digest( const DTN::Bundle& b );

         static DTN::ByteString digest( const DTN::ByteString& originator,
                                        uint32_t seqNum );

         static DigestList* parseSummaryVector( const DTN::ByteString& sv );

         void set_max_hops( uint32_t h ) { m_max_hops = h; }

         void forwardLastHop( const DTN::ByteString& addr, DTN::Node& node );

         bool seen( const DTN::ByteString& digest );

      protected :
         virtual DTN::BundlePointer p_addBundle( DTN::Bundle* b );
         virtual void p_deleteBundle( DTN::Bundle* b );

         virtual DTN::BundlePointer p_getPointer(
            const DTN::BundlePointer& p );

         virtual DTN::BundlePointer p_getPointer(
            const DTN::ByteString& sender,
            uint32_t seqNum );

         virtual bool p_validatePointer( const DTN::BundlePointer& p );

         virtual size_t p_bytesUsed() { return m_bytesUsed; }

         virtual size_t p_bundles() { return m_list.size(); }

         virtual void p_shrinkStore( size_t s );

      private :
         uint32_t    m_max_hops;
         BundleList  m_list;
         DigestMap   m_digestMap;
         DestMap     m_destMap;
         HistorySet  m_history;
         size_t      m_bytesUsed;
   };

   class EpidemicStoreItr : public DTN::BundlePointerRepr
   {
      public :
         EpidemicStoreItr( EpidemicStore& store,
                           EpidemicStore::iterator itr );
         virtual ~EpidemicStoreItr();

         virtual bool operator==( const DTN::BundlePointerRepr& b );

         virtual DTN::BundlePointerRepr* next();

         virtual DTN::BundlePointerRepr* clone();

         virtual DTN::Bundle* bundle() const;

      private :
         EpidemicStore&           m_store;
         EpidemicStore::iterator  m_itr;
   };
}


#endif // __EPIDEMIC_EPIDEMIC_STORE_H__

---