Module.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_PPI_Module_
#define HH_SENF_PPI_Module_ 1

// Custom includes
#include <boost/noncopyable.hpp>
#include <boost/ptr_container/ptr_vector.hpp>
#include <senf/Scheduler/ClockService.hh>
#include <senf/Utils/Console/ScopedDirectory.hh>
#include "predecl.hh"
#include "ModuleManager.hh"

//#include "Module.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace ppi {

    namespace detail { class EventBindingBase; }

namespace module {

    class Module
        : ModuleManager::Initializable, boost::noncopyable
    {
    public:
        virtual ~Module();

    protected:
        Module();

#ifdef DOXYGEN
        Route<connector::InputConnector, connector::OutputConnector> &
        route(connector::InputConnector & input, connector::OutputConnector & output);

        Route<connector::InputConnector, EventDescriptor> &
        route(connector::InputConnector & input, EventDescriptor & output);

        Route<EventDescriptor, connector::OutputConnector> &
        route(EventDescriptor & input, connector::OutputConnector & output);

#else
#       define route_decl(Source, Target)               \
            Route<Source, Target> &                     \
            route(Source & source, Target & target);

        route_decl( connector::GenericPassiveInput, connector::GenericActiveOutput);
        route_decl( connector::GenericPassiveInput, connector::GenericPassiveOutput);
        route_decl( connector::GenericActiveInput,  connector::GenericPassiveOutput);
        route_decl( connector::GenericActiveInput,  connector::GenericActiveOutput);
        route_decl( connector::GenericPassiveInput, EventDescriptor);
        route_decl( connector::GenericActiveInput,  EventDescriptor);
        route_decl( EventDescriptor, connector::GenericPassiveOutput);
        route_decl( EventDescriptor, connector::GenericActiveOutput);

#undef Route_decl
#endif

        void noroute(connector::Connector & connector); 

#ifndef DOXYGEN
        template <class Descriptor, class Target>
        void registerEvent(Descriptor & descriptor, Target target);
#else
        template <class Target>
        void registerEvent(EventDescriptor & descriptor, Target target);

#endif

        ClockService::clock_type const & time() const; 

        ClockService::clock_type const & now() const; 

#ifndef DOXYGEN
        virtual void macro_SENF_PPI_MODULE_missing() = 0;
#endif
        virtual void v_init();          

        console::DirectoryNode & sysConsoleDir() const;

#ifndef DOXYGEN
    public:
#endif
        void destroy();

    private:
        EventManager & eventManager() const;
        ModuleManager & moduleManager() const;

        void registerConnector(connector::Connector & connector);
        void unregisterConnector(connector::Connector & connector);
        void unregisterEvent(EventDescriptor & event);

        RouteBase & addRoute(std::unique_ptr<RouteBase> route);

        typedef std::vector<connector::Connector *> ConnectorRegistry;
        ConnectorRegistry connectorRegistry_;

        typedef boost::ptr_vector<RouteBase> RouteInfoBase;
        RouteInfoBase routes_;

        console::ScopedDirectory<> sysConsoleDir_;

        template <class Source, class Target>
        friend struct detail::RouteHelper;
        friend class senf::ppi::ModuleManager;
        friend class connector::Connector;
        friend class senf::ppi::detail::EventBindingBase;
    };

#   define SENF_PPI_MODULE(name)                                                                  \
    public:                                                                                       \
        ~ name() { destroy(); }                                                                   \
        void macro_SENF_PPI_MODULE_missing() override {}                                          \
    private:

}}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "Module.cci"
#include "Module.ct"
//#include "Module.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// comment-column: 40
// End: