NativeDaemon.h

Go to the documentation of this file.

/*
 * NativeDaemon.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.
 *
 */

#include "Component.h"
#include "core/AbstractWorker.h"
#include "net/IPNDAgent.h"
#include "storage/BundleSeeker.h"
#include "storage/BundleIndex.h"
#include "core/EventReceiver.h"

#include "core/NodeEvent.h"
#include "core/GlobalEvent.h"
#include "core/CustodyEvent.h"
#include "net/BundleReceivedEvent.h"
#include "net/TransferCompletedEvent.h"
#include "net/TransferAbortedEvent.h"
#include "net/ConnectionEvent.h"
#include "routing/QueueBundleEvent.h"

#include <ibrdtn/ibrdtn.h>
#ifdef IBRDTN_SUPPORT_BSP
#include "security/exchange/KeyExchangeEvent.h"
#endif

#include <ibrcommon/Exceptions.h>
#include <list>
#include <set>
#include <map>

#ifndef NATIVEDAEMON_H_
#define NATIVEDAEMON_H_

namespace dtn
{
        namespace daemon
        {
                enum DaemonRunLevel {
                        RUNLEVEL_ZERO = 0,
                        RUNLEVEL_CORE = 1,
                        RUNLEVEL_STORAGE = 2,
                        RUNLEVEL_ROUTING = 3,
                        RUNLEVEL_API = 4,
                        RUNLEVEL_NETWORK = 5,
                        RUNLEVEL_ROUTING_EXTENSIONS = 6
                };

                class NativeDaemonCallback {
                public:

                        virtual ~NativeDaemonCallback() = 0;

                        virtual void levelChanged(DaemonRunLevel level) throw () = 0;
                };

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

                        virtual void eventRaised(const std::string &event, const std::string &action, const std::vector<std::string> &data) throw () = 0;
                };

                class NativeNode {
                public:
                        enum Type {
                                NODE_P2P,
                                NODE_CONNECTED,
                                NODE_DISCOVERED,
                                NODE_INTERNET,
                                NODE_STATIC
                        };

                        NativeNode(const std::string &e)
                        : eid(e), type(NODE_STATIC) { };

                        ~NativeNode() {};

                        std::string eid;
                        Type type;
                };

                class NativeKeyInfo {
                public:
                        std::string endpoint;
                        std::string fingerprint;
                        std::string data;
                        int trustlevel;
                        unsigned int flags;
                };

                class NativeStats {
                public:
                        NativeStats()
                        : uptime(0), timestamp(0), neighbors(0), storage_size(0),
                          time_offset(0.0), time_rating(0.0), time_adjustments(0),
                          bundles_stored(0), bundles_expired(0),
                          bundles_received(0), bundles_transmitted(0), bundles_aborted(0),
                          bundles_requeued(0), bundles_queued(0)
                        { };

                        ~NativeStats() { };

                        size_t uptime;
                        size_t timestamp;
                        size_t neighbors;
                        size_t storage_size;

                        double time_offset;
                        double time_rating;
                        size_t time_adjustments;

                        size_t bundles_stored;
                        size_t bundles_expired;
                        size_t bundles_received;
                        size_t bundles_transmitted;
                        size_t bundles_aborted;
                        size_t bundles_requeued;
                        size_t bundles_queued;

                        const std::vector<std::string>& getTags() {
                                return _tags;
                        }

                        const std::string& getData(int index) {
                                return _data[index];
                        }

                        void addData(const std::string &tag, const std::string &data) {
                                _tags.push_back(tag);
                                _data.push_back(data);
                        }

                private:
                        std::vector<std::string> _tags;
                        std::vector<std::string> _data;
                };

                class NativeDaemonException : public ibrcommon::Exception
                {
                public:
                        NativeDaemonException(std::string what = "An error happened.") throw() : ibrcommon::Exception(what)
                        {
                        };
                };

                class NativeEventLoop;

                class NativeDaemon :
                        public dtn::core::EventReceiver<dtn::core::NodeEvent>,
                        public dtn::core::EventReceiver<dtn::core::GlobalEvent>,
                        public dtn::core::EventReceiver<dtn::core::CustodyEvent>,
                        public dtn::core::EventReceiver<dtn::net::BundleReceivedEvent>,
                        public dtn::core::EventReceiver<dtn::net::TransferAbortedEvent>,
                        public dtn::core::EventReceiver<dtn::net::TransferCompletedEvent>,
                        public dtn::core::EventReceiver<dtn::net::ConnectionEvent>,
                        public dtn::core::EventReceiver<dtn::routing::QueueBundleEvent>
#ifdef IBRDTN_SUPPORT_BSP
                        , public dtn::core::EventReceiver<dtn::security::KeyExchangeEvent>
#endif
                {
                        static const std::string TAG;

                public:
                        NativeDaemon(NativeDaemonCallback *statecb = NULL, NativeEventCallback *eventcb = NULL);

                        virtual ~NativeDaemon();

                        DaemonRunLevel getRunLevel() const throw ();

                        void init(DaemonRunLevel rl) throw (NativeDaemonException);

                        void wait(DaemonRunLevel rl) throw ();

                        void reload() throw ();

                        void setDebug(int level) throw ();

                        void setLogging(const std::string &defaultTag, int logLevel) const throw ();

                        void setLogFile(const std::string &path, int logLevel) const throw ();

                        void setConfigFile(const std::string &config_file);

                        std::string getLocalUri() const throw ();

                        std::vector<std::string> getNeighbors() const throw ();

                        NativeNode getInfo(const std::string &neighbor_eid) const throw (NativeDaemonException);

                        NativeStats getStats() throw ();

                        void addConnection(std::string eid, std::string protocol, std::string address, std::string service, bool local = false) const throw ();

                        void removeConnection(std::string eid, std::string protocol, std::string address, std::string service, bool local = false) const throw ();

                        void initiateConnection(std::string eid) const;

                        void setGloballyConnected(bool connected) const;

                        void onKeyExchangeBegin(std::string eid, int protocol, std::string password) const;

                        void onKeyExchangeResponse(std::string eid, int protocol, int session, int step, std::string data) const;

                        NativeKeyInfo getKeyInfo(std::string eid) const throw (NativeDaemonException);

                        void removeKey(std::string eid) const throw (NativeDaemonException);

                        virtual void raiseEvent(const dtn::core::NodeEvent &evt) throw ();
                        virtual void raiseEvent(const dtn::core::GlobalEvent &evt) throw ();
                        virtual void raiseEvent(const dtn::core::CustodyEvent &evt) throw ();
                        virtual void raiseEvent(const dtn::net::BundleReceivedEvent &evt) throw ();
                        virtual void raiseEvent(const dtn::net::TransferAbortedEvent &evt) throw ();
                        virtual void raiseEvent(const dtn::net::TransferCompletedEvent &evt) throw ();
                        virtual void raiseEvent(const dtn::net::ConnectionEvent &evt) throw ();
                        virtual void raiseEvent(const dtn::routing::QueueBundleEvent &evt) throw ();

#ifdef IBRDTN_SUPPORT_BSP
                        virtual void raiseEvent(const dtn::security::KeyExchangeEvent &evt) throw ();
#endif

                        std::vector<std::string> getVersion() const throw ();

                        void clearStorage() const throw ();

                        void startDiscovery() const throw ();

                        void stopDiscovery() const throw ();

                        void setLeMode(bool low_energy) const throw ();

                private:
                        void init_up(DaemonRunLevel rl) throw (NativeDaemonException);
                        void init_down(DaemonRunLevel rl) throw (NativeDaemonException);

                        void addEventData(const dtn::data::Bundle &b, std::vector<std::string> &data) const;
                        void addEventData(const dtn::data::MetaBundle &b, std::vector<std::string> &data) const;
                        void addEventData(const dtn::data::BundleID &b, std::vector<std::string> &data) const;

                        void bindEvents();
                        void unbindEvents();

                        void init_core() throw (NativeDaemonException);
                        void shutdown_core() throw (NativeDaemonException);

                        void init_storage() throw (NativeDaemonException);
                        void shutdown_storage() const throw (NativeDaemonException);

                        void init_routing() throw (NativeDaemonException);
                        void shutdown_routing() const throw (NativeDaemonException);

                        void init_api() throw (NativeDaemonException);
                        void shutdown_api() throw (NativeDaemonException);

                        void init_network() throw (NativeDaemonException);
                        void shutdown_network() throw (NativeDaemonException);

                        void init_routing_extensions() throw (NativeDaemonException);
                        void shutdown_routing_extensions() const throw (NativeDaemonException);

                        // conditional
                        ibrcommon::Conditional _runlevel_cond;
                        DaemonRunLevel _runlevel;

                        NativeDaemonCallback *_statecb;
                        NativeEventCallback *_eventcb;

                        // list of components
                        typedef std::list< dtn::daemon::Component* > component_list;
                        typedef std::map<DaemonRunLevel, component_list > component_map;
                        component_map _components;

                        // list of embedded apps
                        typedef std::list< dtn::core::AbstractWorker* > app_list;
                        app_list _apps;

                        NativeEventLoop *_event_loop;

                        ibrcommon::File _config_file;
                };

                class NativeEventLoop : public ibrcommon::JoinableThread {
                public:
                        NativeEventLoop(NativeDaemon &daemon);
                        ~NativeEventLoop();
                        virtual void run(void) throw ();
                        virtual void __cancellation() throw ();

                private:
                        NativeDaemon &_daemon;
                };
        } /* namespace daemon */
} /* namespace dtn */
#endif /* NATIVEDAEMON_H_ */