PPI: Implement MonitorModule base class

git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1069 270642c3-0616-0410-b53a-bc976706d245

diff --git a/PPI/MonitorModule.cc b/PPI/MonitorModule.cc
new file mode 100644 (file)
index 0000000..2a5420a
--- /dev/null
+++ b/PPI/MonitorModule.cc
@@ -0,0 +1,68 @@
+// $Id$
+//
+// Copyright (C) 2009 
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Stefan Bund <g0dil@berlios.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+/** \file
+    \brief MonitorModule non-inline non-template implementation */
+
+#include "MonitorModule.hh"
+//#include "MonitorModule.ih"
+
+// Custom includes
+
+//#include "MonitorModule.mpp"
+#define prefix_
+///////////////////////////////cc.p////////////////////////////////////////
+
+prefix_ void senf::ppi::module::MonitorModule::request()
+{
+    Packet p (input());
+    v_handlePacket(p);
+    if (output.connected())
+        output(p);
+}
+
+prefix_ void senf::ppi::module::MonitorModule::throttle()
+{
+    if (output.connected())
+        input.throttle();
+}
+
+prefix_ void senf::ppi::module::MonitorModule::unthrottle()
+{
+    if (output.connected())
+        input.unthrottle();
+}
+
+///////////////////////////////cc.e////////////////////////////////////////
+#undef prefix_
+//#include "MonitorModule.mpp"
+
+\f
+// 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:

diff --git a/PPI/MonitorModule.cci b/PPI/MonitorModule.cci
new file mode 100644 (file)
index 0000000..9c0e62c
--- /dev/null
+++ b/PPI/MonitorModule.cci
@@ -0,0 +1,53 @@
+// $Id$
+//
+// Copyright (C) 2009 
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Stefan Bund <g0dil@berlios.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+/** \file
+    \brief MonitorModule inline non-template implementation */
+
+//#include "MonitorModule.ih"
+
+// Custom includes
+
+#define prefix_ inline
+///////////////////////////////cci.p///////////////////////////////////////
+
+prefix_ senf::ppi::module::MonitorModule::MonitorModule()
+{
+    route(input, output).autoThrottling(false);
+    input.onRequest(&MonitorModule::request);
+    output.onThrottle(&MonitorModule::throttle);
+    output.onUnthrottle(&MonitorModule::unthrottle);
+}
+
+///////////////////////////////cci.e///////////////////////////////////////
+#undef prefix_
+
+\f
+// 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:

diff --git a/PPI/MonitorModule.hh b/PPI/MonitorModule.hh
new file mode 100644 (file)
index 0000000..c5517eb
--- /dev/null
+++ b/PPI/MonitorModule.hh
@@ -0,0 +1,75 @@
+// $Id$
+//
+// Copyright (C) 2009 
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Stefan Bund <g0dil@berlios.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+/** \file
+    \brief MonitorModule public header */
+
+#ifndef HH_SENF_PPI_MonitorModule_
+#define HH_SENF_PPI_MonitorModule_ 1
+
+// Custom includes
+#include "Module.hh"
+#include "Connectors.hh"
+
+//#include "MonitorModule.mpp"
+///////////////////////////////hh.p////////////////////////////////////////
+
+namespace senf {
+namespace ppi {
+namespace module {
+
+    class MonitorModule : public Module
+    {
+    public:
+        senf::ppi::connector::PassiveInput<> input;
+        senf::ppi::connector::ActiveOutput<> output;
+
+    protected:
+        MonitorModule();
+
+        virtual void v_handlePacket(Packet const & p) = 0;
+
+    private:
+        void request();
+        void throttle();
+        void unthrottle();
+    };
+        
+
+}}}
+
+///////////////////////////////hh.e////////////////////////////////////////
+#include "MonitorModule.cci"
+//#include "MonitorModule.ct"
+//#include "MonitorModule.cti"
+#endif
+
+\f
+// 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:

diff --git a/PPI/MonitorModule.test.cc b/PPI/MonitorModule.test.cc
new file mode 100644 (file)
index 0000000..b0f47c2
--- /dev/null
+++ b/PPI/MonitorModule.test.cc
@@ -0,0 +1,143 @@
+// $Id$
+//
+// Copyright (C) 2009 
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     Stefan Bund <g0dil@berlios.de>
+//
+// This program is free software; you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+/** \file
+    \brief MonitorModule.test unit tests */
+
+//#include "MonitorModule.test.hh"
+//#include "MonitorModule.test.ih"
+
+// Custom includes
+#include "MonitorModule.hh"
+#include "DebugModules.hh"
+
+#include "../Utils/auto_unit_test.hh"
+#include <boost/test/test_tools.hpp>
+
+#define prefix_
+///////////////////////////////cc.p////////////////////////////////////////
+
+namespace {
+    
+    class PacketCounter : public senf::ppi::module::MonitorModule
+    {
+        SENF_PPI_MODULE(PacketCounter);
+    public:
+        PacketCounter() : count (0) {}
+        void v_handlePacket(senf::Packet const & p) { ++count; }
+        unsigned count;
+    };
+
+}
+
+BOOST_AUTO_UNIT_TEST(monitorModulePassthrough)
+{
+    senf::ppi::module::debug::ActiveSource source;
+    senf::ppi::module::debug::PassiveSink sink;
+    PacketCounter counter;
+    
+    senf::ppi::connect(source, counter);
+    senf::ppi::connect(counter, sink);
+
+    senf::ppi::init();
+    
+    senf::Packet p (senf::DataPacket::create());
+
+    BOOST_CHECK_EQUAL( counter.count, 0u );
+    source.submit(p);
+    BOOST_CHECK_EQUAL( counter.count, 1u );
+    BOOST_CHECK( sink.pop_front() == p );
+    BOOST_CHECK( source );
+    sink.throttle();
+    BOOST_CHECK( ! source );
+    sink.unthrottle();
+    BOOST_CHECK( source );
+}
+
+BOOST_AUTO_UNIT_TEST(monitorModuleNoPassthrough)
+{
+    senf::ppi::module::debug::ActiveSource source;
+    PacketCounter counter;
+
+    senf::ppi::connect(source, counter);
+
+    senf::ppi::init();
+
+    senf::Packet p (senf::DataPacket::create());
+    
+    BOOST_CHECK_EQUAL( counter.count, 0u );
+    source.submit(p);
+    BOOST_CHECK_EQUAL( counter.count, 1u );
+    BOOST_CHECK( source );
+}
+
+BOOST_AUTO_UNIT_TEST(monitorModuleDynamicConnect)
+{
+    senf::ppi::module::debug::ActiveSource source;
+    PacketCounter counter;
+
+    senf::ppi::connect(source, counter);
+
+    senf::ppi::init();
+
+    senf::Packet p (senf::DataPacket::create());
+    
+    BOOST_CHECK_EQUAL( counter.count, 0u );
+    source.submit(p);
+    BOOST_CHECK_EQUAL( counter.count, 1u );
+    BOOST_CHECK( source );
+
+    senf::ppi::module::debug::PassiveSink sink;
+    senf::ppi::connect(counter, sink);
+    senf::ppi::init(); // Needs to be called since I'm not running in the scheduler !!
+
+    BOOST_CHECK( source );
+    source.submit(p);
+    BOOST_CHECK_EQUAL( counter.count, 2u );
+    BOOST_CHECK( sink.pop_front() == p );
+    sink.throttle();
+    BOOST_CHECK( ! source );
+    sink.unthrottle();
+    BOOST_CHECK( source );
+
+    counter.output.disconnect();
+    senf::ppi::init(); // Needs to be called since I'm not running in the scheduler !!
+
+    BOOST_CHECK( source );
+    source.submit(p);
+    BOOST_CHECK_EQUAL( counter.count, 3u );
+    
+}
+
+///////////////////////////////cc.e////////////////////////////////////////
+#undef prefix_
+
+\f
+// 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: