Route.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_Route_
#define HH_SENF_PPI_Route_ 1

// Custom includes
#include "predecl.hh"

//#include "Route.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace ppi {

    class RouteBase
    {
    public:
        virtual ~RouteBase();

        bool hasConnector(connector::Connector const & conn) const;
        bool hasEvent(EventDescriptor const & event) const;

    protected:
        RouteBase();

#ifdef DOXYGEN
        Source & source() const;        

        Target & target() const;        

#endif

    private:
        virtual bool v_hasConnector(connector::Connector const & conn) const = 0;
        virtual bool v_hasEvent(EventDescriptor const & event) const = 0;
    };

    class ForwardingRoute
        : public RouteBase
    {
    public:
        bool autoThrottling() const;    
        void autoThrottling(bool state); 

        bool throttled() const;         

    protected:
        ForwardingRoute();

        // Called to register this route with the connectors forwarding information base
        template <class T> void registerRoute(T & ob);
        template <class T> void unregisterRoute(T & ob);

        template <class T> void notifyThrottle(T & ob);
        template <class T> void notifyUnthrottle(T & ob);

    private:
        // called to forward a throttling notification along the route
        void notifyThrottle();
        void notifyUnthrottle();

        // Implemented in the derived classes to forward throttling notifications
        virtual void v_notifyThrottle() = 0;
        virtual void v_notifyUnthrottle() = 0;
        virtual bool v_throttled() const = 0;

        bool autoThrottling_;

        friend class connector::ActiveConnector;
    };

}}

// We need detail::RouteImplementation here ...
#include "Route.ih"

namespace senf {
namespace ppi {

    template <class Source, class Target>
    class Route
        : public detail::RouteImplementation<Source,Target>
    {
    private:
        typedef detail::RouteImplementation<Source,Target> Base;
        typedef detail::RouteImplementation<Source,Target> Implementation;

        Route(Source & source, Target & target);

        friend class module::Module;
    };

}}

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "Route.cci"
#include "Route.ct"
#include "Route.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: