4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
7 // Version 1.0 (the "License"); you may not use this file except in compliance
8 // with the License. You may obtain a copy of the License at
9 // http://senf.berlios.de/license.html
11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
12 // but modifies the Mozilla Public License Version 1.1.
13 // See the full license text for the amendments.
15 // Software distributed under the License is distributed on an "AS IS" basis,
16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
17 // for the specific language governing rights and limitations under the License.
19 // The Original Code is Fraunhofer FOKUS code.
21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
23 // All Rights Reserved.
26 // Stefan Bund <g0dil@berlios.de>
29 \brief MonitorModule public header */
31 #ifndef HH_SENF_PPI_MonitorModule_
32 #define HH_SENF_PPI_MonitorModule_ 1
36 #include "Connectors.hh"
38 //#include "MonitorModule.mpp"
39 //-/////////////////////////////////////////////////////////////////////////////////////////////////
45 /** \brief Base class providing simple monitor %module support
47 A monitor %module is a \ref senf::ppi::module::Module "module" which needs information
48 about traversing packets but does not really act on the packets. Because of this, it is
49 \e optional to connect the output: If the output is not connected, the packets will be
52 This allows to add monitor modules either into an existing chain or add them using an
55 To write a monitor %module, derive from senf::ppi::module::MonitorModule instead of
56 senf::ppi::module and implement v_handlePacket():
60 : public senf::ppi::module::MonitorModule<>
62 SENF_PPI_MODULE(CountPackets);
64 CountPackets() : counter_ (0u) {}
67 virtual void v_handlePacket(Packet const & p)
74 You may of course add events (or even further connectors besides \c input and \c output
75 provided by MonitorModule) to the %module.
77 \tparam PacketType type of packet expected on input and sent on output. This is also the
78 type of the v_handlePacket() argument.
80 template <class PacketType=Packet>
81 class MonitorModule : public Module
84 senf::ppi::connector::PassiveInput<PacketType> input;
85 senf::ppi::connector::ActiveOutput<PacketType> output;
90 virtual void v_handlePacket(PacketType const & p) = 0; ///< Called for each packet
101 //-/////////////////////////////////////////////////////////////////////////////////////////////////
102 //#include "MonitorModule.cci"
103 #include "MonitorModule.ct"
104 #include "MonitorModule.cti"
111 // comment-column: 40
112 // c-file-style: "senf"
113 // indent-tabs-mode: nil
114 // ispell-local-dictionary: "american"
115 // compile-command: "scons -u test"