Node.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 __DTN_NODE_H__
#define __DTN_NODE_H__

#include "config.h"
#include "Bundle.h"
#include "Consumer.h"
#include "VolatileBundleStore.h"
#include "PersistentBundleStore.h"
#include "VolatileStorePolicy.h"
#include "ForwardingPolicy.h"
#include "CustodyPolicy.h"

#include <map>
#include <set>

namespace DTN
{
   class Link;

   class Node
   {
      public:
         typedef std::set< Link* >  LinkList;

         Node();

         virtual ~Node();

         uint32_t nextSeq() { return m_seqNum++; }

         void forward( Bundle* b );

         void broadcast( Bundle* b );

         bool addPersistent( const Bundle& b );

         bool validate( const BundlePointer& p );

         bool validatePersistent( const BundlePointer& p );

         void remove( Bundle* b,
                      bool dealloc = true,
                      const DropCause& c=DropCause::inst );

         void removePersistent( Bundle* b, bool dropping = true );

         void send( Bundle* b, Link& l );

         void recv( Bundle* b );

         void forwardOn( Link& l );

         void retryStored();

         void drop( Bundle* b, const DropCause& c=DropCause::inst );

         void recordPersistentRemove( const Bundle& b, bool cleanup=true );

         virtual void setAddr( const ByteString& addr );

         const ByteString& addr() const { return m_addr; }

         void setConsumer( Consumer* c );

         size_t volatileCap() const { return m_volatileCap; }

         size_t usedVolatileCap( bool cleanup=true ) const;

         size_t volatileBundles( bool cleanup=true ) const;

         size_t persistentCap() const { return m_persistentCap; }

         size_t usedPersistentCap( bool cleanup=true ) const;

         size_t persistentBundles( bool cleanup=true ) const;

         BundlePointer cachedVolatile();

         BundlePointer cachedVolatile( const BundlePointer& p );

         BundlePointer cachedVolatile( const ByteString& sender,
                                       uint32_t seqNum );

         const BundlePointer cachedVolatile() const;

         const BundlePointer cachedVolatile( const BundlePointer& p ) const;

         const BundlePointer cachedVolatile( const ByteString& sender,
                                             uint32_t seqNum ) const;

         BundlePointer cachedPersistent();

         BundlePointer cachedPersistent( const BundlePointer& p );

         BundlePointer cachedPersistent( const ByteString& sender,
                                         uint32_t seqNum );

         const BundlePointer cachedPersistent() const;

         const BundlePointer cachedPersistent( const BundlePointer& p ) const;

         const BundlePointer cachedPersistent( const ByteString& sender,
                                               uint32_t seqNum ) const;

         void setVolatileStore( VolatileBundleStore* s );

         void setPersistentStore( PersistentBundleStore* s );

         void setVolatileStorePolicy( VolatileStorePolicy* p );

         void setForwardingPolicy( ForwardingPolicy* p );

         void setCustodyPolicy( CustodyPolicy* p );

         bool hasVolatileStore()       const { return 0 != m_volatileStore; }
         bool hasPersistentStore()     const { return 0 != m_persistentStore; }
         bool hasVolatileStorePolicy() const { return 0 != m_vstorePol; }
         bool hasForwardingPolicy()    const { return 0 != m_forwPol; }
         bool hasCustodyPolicy()       const { return 0 != m_custPol; }

         void setVolatileCap( size_t cap );

         void setPersistentCap( size_t cap );

         void signalExhausted( const Bundle& b );

         void addLink( Link* l );

      protected:
         virtual bool ours( const ByteString& destination );

         virtual void consume( Bundle* b );

         virtual void acknowledge( const Bundle& b );

      private:
         uint32_t           m_seqNum; 
         ByteString         m_addr; 
         Consumer*          m_consumer; 
         size_t             m_volatileCap; 
         BundleStore*       m_volatileStore; 
         size_t             m_persistentCap; 
         BundleStore*       m_persistentStore; 
         VolatileStorePolicy* m_vstorePol; 
         ForwardingPolicy*  m_forwPol; 
         CustodyPolicy*     m_custPol; 
         LinkList           m_links; 
   };

}; // DTN

#endif /* __DTN_NODE_H__ */

---