BundleSet.h

Go to the documentation of this file.

/*
 * BundleSet.h
 *
 * Copyright (C) 2013 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.
 *
 *  Created on: 18.12.2012
 */

#ifndef BUNDLESET_H_
#define BUNDLESET_H_

#include "ibrdtn/data/BundleSetImpl.h"
#include "ibrdtn/data/MetaBundle.h"
#include <ibrcommon/data/BloomFilter.h>
#include <set>

namespace dtn
{
        namespace data
        {
                class BundleSet
                {
                public:
                        class Listener {
                        public:
                                virtual ~Listener() = 0;
                                virtual void eventBundleExpired(const dtn::data::MetaBundle&) = 0;
                        };

                        class Factory {
                        public:
                                virtual ~Factory() = 0;

                                virtual BundleSetImpl* create(Listener* listener, Size bf_size) = 0;
                                virtual BundleSetImpl* create(const std::string &name, Listener* listener, Size bf_size) = 0;
                        };

                        BundleSet(BundleSet::Listener *listener = NULL, Length bf_size = 1024);

                        BundleSet(const std::string &name, BundleSet::Listener *listener = NULL, Length bf_size = 1024);

                        virtual ~BundleSet();

                        BundleSet(const BundleSet&);

                        BundleSet& operator=(const BundleSet&);

                        virtual void add(const dtn::data::MetaBundle &bundle) throw ();

                        virtual void clear() throw ();

                        virtual bool has(const dtn::data::BundleID &bundle) const throw ();

                        virtual void expire(const Timestamp timestamp) throw ();

                        virtual Size size() const throw ();

                        Length getLength() const throw ();

                        const ibrcommon::BloomFilter& getBloomFilter() const throw ();

                        std::set<dtn::data::MetaBundle> getNotIn(const ibrcommon::BloomFilter &filter) const throw ();

                        void sync() throw ();

                        std::ostream& serialize(std::ostream &stream) const;
                        std::istream& deserialize(std::istream &stream);

                        friend std::ostream &operator<<(std::ostream &stream, const BundleSet &obj);
                        friend std::istream &operator>>(std::istream &stream, BundleSet &obj);

                        static void setFactory(dtn::data::BundleSet::Factory*);

                private:
                        static BundleSetImpl* __create(Listener* listener, Size bf_size);
                        static BundleSetImpl* __create(const std::string &name, Listener* listener, Size bf_size);

                        refcnt_ptr<BundleSetImpl> _set_impl;

                        static dtn::data::BundleSet::Factory *__factory__;
                };
        } /* namespace data */
} /* namespace dtn */
#endif /* BUNDLESET_H_ */