DebugModules.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_DebugModules_
#define HH_SENF_PPI_DebugModules_ 1

// Custom includes
#include <deque>
#include <senf/Utils/safe_bool.hh>
#include <senf/Utils/Logger/SenfLog.hh>
#include <senf/Utils/Logger/Logger.hh>
#include "MonitorModule.hh"
#include "ActiveFeeder.hh"

//#include "DebugModules.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {
namespace ppi {
namespace module {
namespace debug {

    class ActiveSource
        : public Module,
          public safe_bool<ActiveSource>
    {
        SENF_PPI_MODULE(ActiveSource);

    public:
        connector::ActiveOutput<> output;

        ActiveSource();

        void submit(Packet const & packet);     

        bool boolean_test() const;      
    };

    class PassiveSource
        : public Module
    {
        SENF_PPI_MODULE(PassiveSource);

        typedef std::deque<Packet> Queue;

    public:
        typedef Queue::size_type size_type;

        connector::PassiveOutput<> output;

        PassiveSource();

        void throttle();                
        void unthrottle();              

        void submit(Packet const & packet);     

        bool empty();                   
        size_type size();               

    private:
        void request();
        virtual void v_init() override;

        Queue packets_;
    };

    class ActiveSink
        : public Module,
          public safe_bool<ActiveSink>
    {
        SENF_PPI_MODULE(ActiveSink);

    public:
        connector::ActiveInput<> input;

        ActiveSink();

        Packet request();               

        bool boolean_test() const;      
    };

    class PassiveSink
        : public Module
    {
        SENF_PPI_MODULE(PassiveSink);

        typedef std::deque<Packet> Queue;

    public:
        typedef Queue::size_type size_type;
        typedef Queue::const_iterator iterator;

        connector::PassiveInput<> input;

        PassiveSink();

        void throttle();                
        void unthrottle();              

        bool empty();                   
        size_type size();               
        iterator begin();               
        iterator end();                 

        Packet front();                 
        Packet pop_front();             

        void clear();                   

    private:
        void request();

        Queue packets_;
    };

    class ActiveFeederSource
    {
    private:
        PassiveSource source;
        ActiveFeeder feeder;

    public:
        typedef PassiveSource::size_type size_type;

        connector::ActiveOutput<> & output;

        ActiveFeederSource();

        void submit(Packet packet);     
        bool empty();                   
        size_type size();               
    };

    class ActiveFeederSink
    {
    private:
        PassiveSink sink;
        ActiveFeeder feeder;

    public:
        typedef PassiveSink::size_type size_type;
        typedef PassiveSink::iterator iterator;

        connector::ActiveInput<> & input;

        ActiveFeederSink();

        bool empty();
        size_type size();
        iterator begin();
        iterator end();

        Packet front();
        Packet pop_front();

        void clear();
    };

    template < class Stream = log::Debug,
               class Area   = log::DefaultArea,
               class Level  = log::VERBOSE >
    class Logger
        : public MonitorModule<>
    {
        SENF_PPI_MODULE(Logger);
    public:
        Logger();
        explicit Logger(std::string label);

    private:
        virtual void v_handlePacket(Packet const & packet);

        std::string label_;
    };

}}}}

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

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