BundleStorage.h

Go to the documentation of this file.

/*
 * BundleStorage.h
 *
 * Copyright (C) 2011 IBR, TU Braunschweig
 *
 * Written-by: Johannes Morgenroth <morgenroth@ibr.cs.tu-bs.de>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

#ifndef BUNDLESTORAGE_H_
#define BUNDLESTORAGE_H_

#include <storage/BundleSeeker.h>
#include <storage/BundleResult.h>
#include <storage/BundleIndex.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 <ibrcommon/thread/Mutex.h>

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

namespace dtn
{
        namespace storage
        {
                class BundleStorage : public BundleSeeker
                {
                public:
                        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)
                                {
                                };
                        };

                        virtual ~BundleStorage() = 0;

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

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

                        virtual void get(const BundleSelector &cb, BundleResult &result) throw (NoBundleFoundException, BundleSelectorException) = 0;

                        virtual const eid_set 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 dtn::data::Size count() { return 0; };

                        dtn::data::Length size() const;

                        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);

                        void attach(dtn::storage::BundleIndex *index);

                        void detach(dtn::storage::BundleIndex *index);

                        /*** BEGIN: methods for unit-testing ***/

                        virtual void wait() { };

                        virtual void setFaulty(bool mode) { _faulty = mode; };

                        /*** END: methods for unit-testing ***/

                protected:
                        BundleStorage(const dtn::data::Length &maxsize);

                        void allocSpace(const dtn::data::Length &size) throw (StorageSizeExeededException);
                        void freeSpace(const dtn::data::Length &size) throw ();
                        void clearSpace() throw ();

                        void eventBundleAdded(const dtn::data::MetaBundle &b) throw ();
                        void eventBundleRemoved(const dtn::data::BundleID &id) throw ();

                        bool _faulty;

                private:
                        ibrcommon::Mutex _sizelock;
                        const dtn::data::Length _maxsize;
                        dtn::data::Length _currentsize;

                        ibrcommon::Mutex _index_lock;
                        typedef std::set<dtn::storage::BundleIndex*> index_list;
                        index_list _indexes;
                };
        }
}

#endif /* BUNDLESTORAGE_H_ */