StaticRoutingExtension.h

Go to the documentation of this file.

/*
 * StaticRoutingExension.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 STATICROUTINGEXTENSION_H_
#define STATICROUTINGEXTENSION_H_

#include "routing/StaticRoute.h"
#include "routing/RoutingExtension.h"
#include "routing/StaticRouteChangeEvent.h"
#include "core/TimeEvent.h"
#include "core/EventReceiver.h"
#include <ibrdtn/data/MetaBundle.h>
#include <ibrcommon/thread/Queue.h>
#include <ibrcommon/thread/Mutex.h>

namespace dtn
{
        namespace routing
        {
                class StaticRoutingExtension : public RoutingExtension, public ibrcommon::JoinableThread,
                        public dtn::core::EventReceiver<dtn::core::TimeEvent>,
                        public dtn::core::EventReceiver<dtn::routing::StaticRouteChangeEvent>
                {
                        static const std::string TAG;

                public:
                        StaticRoutingExtension();
                        virtual ~StaticRoutingExtension();

                        virtual const std::string getTag() const throw ();

                        virtual void eventDataChanged(const dtn::data::EID &peer) throw ();

                        virtual void eventBundleQueued(const dtn::data::EID &peer, const dtn::data::MetaBundle &meta) throw ();

                        void raiseEvent(const dtn::core::TimeEvent &evt) throw ();
                        void raiseEvent(const dtn::routing::StaticRouteChangeEvent &evt) throw ();
                        void componentUp() throw ();
                        void componentDown() throw ();

                protected:
                        void run() throw ();
                        void __cancellation() throw ();

                private:
                        class EIDRoute : public StaticRoute
                        {
                        public:
                                EIDRoute(const dtn::data::EID &match, const dtn::data::EID &nexthop, const dtn::data::Timestamp &expiretime = 0);
                                virtual ~EIDRoute();

                                bool match(const dtn::data::EID &eid) const;
                                const dtn::data::EID& getDestination() const;

                                const std::string toString() const;

                                const dtn::data::Timestamp& getExpiration() const;

                                void raiseExpired() const;

                                bool equals(const StaticRoute &route) const;

                        private:
                                const dtn::data::EID _nexthop;
                                const dtn::data::EID _match;
                                const dtn::data::Timestamp expiretime;
                        };

                        class Task
                        {
                        public:
                                virtual ~Task() {};
                                virtual std::string toString() = 0;
                        };

                        class SearchNextBundleTask : public Task
                        {
                        public:
                                SearchNextBundleTask(const dtn::data::EID &eid);
                                virtual ~SearchNextBundleTask();

                                virtual std::string toString();

                                const dtn::data::EID eid;
                        };

                        class ProcessBundleTask : public Task
                        {
                        public:
                                ProcessBundleTask(const dtn::data::MetaBundle &meta, const dtn::data::EID &origin);
                                virtual ~ProcessBundleTask();

                                virtual std::string toString();

                                const dtn::data::MetaBundle bundle;
                                const dtn::data::EID origin;
                        };

                        class ClearRoutesTask : public Task
                        {
                        public:
                                ClearRoutesTask();
                                virtual ~ClearRoutesTask();
                                virtual std::string toString();
                        };

                        class RouteChangeTask : public Task
                        {
                        public:
                                enum CHANGE_TYPE
                                {
                                        ROUTE_ADD = 0,
                                        ROUTE_DEL = 1
                                };

                                RouteChangeTask(CHANGE_TYPE type, StaticRoute *route);
                                virtual ~RouteChangeTask();

                                virtual std::string toString();

                                CHANGE_TYPE type;
                                StaticRoute *route;
                        };

                        class ExpireTask : public Task
                        {
                        public:
                                ExpireTask(dtn::data::Timestamp timestamp);
                                virtual ~ExpireTask();

                                virtual std::string toString();

                                dtn::data::Timestamp timestamp;
                        };

                        ibrcommon::Queue<StaticRoutingExtension::Task* > _taskqueue;

                        std::list<StaticRoute*> _routes;
                        ibrcommon::Mutex _expire_lock;
                        dtn::data::Timestamp next_expire;
                };
        }
}

#endif /* STATICROUTINGEXTENSION_H_ */