daemon/src/storage/BundleStorage.h

Go to the documentation of this file.

/*
 * BundleStorage.h
 *
 *  Created on: 24.03.2009
 *      Author: morgenro
 */

#ifndef BUNDLESTORAGE_H_
#define BUNDLESTORAGE_H_

#include <ibrdtn/data/Bundle.h>
#include <ibrdtn/data/BundleID.h>
#include <ibrdtn/data/MetaBundle.h>
#include <ibrdtn/data/CustodySignalBlock.h>
#include <ibrcommon/data/BloomFilter.h>

#include <stdexcept>
#include <iterator>
#include <set>

namespace dtn
{
        namespace storage
        {
                class BundleStorage
                {
                public:
                        class NoBundleFoundException : public dtn::MissingObjectException
                        {
                        public:
                                NoBundleFoundException(string what = "No bundle match the specified criteria.") throw() : dtn::MissingObjectException(what)
                                {
                                };
                        };

                        class BundleLoadException : public NoBundleFoundException
                        {
                        public:
                                BundleLoadException(string what = "Error while loading bundle data.") throw() : NoBundleFoundException(what)
                                {
                                };
                        };

                        class StorageSizeExeededException : public ibrcommon::Exception
                        {
                        public:
                                StorageSizeExeededException(string what = "No space left in the storage.") throw() : ibrcommon::Exception(what)
                                {
                                };
                        };

                        class BundleFilterCallback
                        {
                        public:
                                virtual ~BundleFilterCallback() {};

                                virtual size_t limit() const { return 1; };

                                virtual bool shouldAdd(const dtn::data::MetaBundle&) const { return false; };
                        };

                        virtual ~BundleStorage() = 0;

                        virtual void store(const dtn::data::Bundle &bundle) = 0;

                        virtual dtn::data::Bundle get(const dtn::data::BundleID &id) = 0;

                        virtual const std::list<dtn::data::MetaBundle> get(BundleFilterCallback &cb) = 0;

                        virtual const std::set<dtn::data::EID> getDistinctDestinations() = 0;

                        virtual void remove(const dtn::data::BundleID &id) = 0;

                        void remove(const dtn::data::Bundle &b);

                        virtual dtn::data::MetaBundle remove(const ibrcommon::BloomFilter &filter);

                        virtual void clear() {};

                        virtual bool empty() { return true; };

                        virtual unsigned int count() { return 0; };

                        virtual void releaseCustody(const dtn::data::EID &custodian, const dtn::data::BundleID &id) = 0;

                        const dtn::data::EID acceptCustody(const dtn::data::MetaBundle &meta);

                        void rejectCustody(const dtn::data::MetaBundle &meta, dtn::data::CustodySignalBlock::REASON_CODE reason = dtn::data::CustodySignalBlock::NO_ADDITIONAL_INFORMATION);

                protected:
                        BundleStorage();
                };
        }
}

#endif /* BUNDLESTORAGE_H_ */