added a flush() member to ActiveBurstSocketSource
[senf.git] / senf / PPI / SocketSource.hh
index 7c06aff..8ef7b99 100644 (file)
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2007
 // 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.
+// The contents of this file are subject to the Fraunhofer FOKUS Public License
+// Version 1.0 (the "License"); you may not use this file except in compliance
+// with the License. You may obtain a copy of the License at 
+// http://senf.berlios.de/license.html
 //
-// 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.
+// The Fraunhofer FOKUS Public License Version 1.0 is based on, 
+// but modifies the Mozilla Public License Version 1.1.
+// See the full license text for the amendments.
 //
-// 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.
+// Software distributed under the License is distributed on an "AS IS" basis, 
+// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
+// for the specific language governing rights and limitations under the License.
+//
+// The Original Code is Fraunhofer FOKUS code.
+//
+// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. 
+// (registered association), Hansastraße 27 c, 80686 Munich, Germany.
+// All Rights Reserved.
+//
+// Contributor(s):
+//   Stefan Bund <g0dil@berlios.de>
 
 /** \file
     \brief SocketSource public header */
@@ -37,7 +42,7 @@
 #include "IOEvent.hh"
 
 //#include "SocketSource.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 namespace ppi {
@@ -59,7 +64,7 @@ namespace ppi {
                                     senf::DatagramFramingPolicy >::policy > Handle;
                                         ///< Handle type supported by this reader
 
-        Packet operator()(Handle handle);
+        Packet operator()(Handle & handle);
                                         ///< Read packet from \a handle
                                         /**< Read a datagram from \a handle and interpret is as
                                              packet of type \c Packet.
@@ -122,12 +127,13 @@ namespace module {
         explicit ActiveSocketSource(Reader reader); ///< Create non-connected reader
                                         /**< The reader will be disabled until a socket is set
                                              \pre Requires \a Reader to be copy constructible */
-        explicit ActiveSocketSource(Handle handle); ///< Create new reader for the given handle
+        explicit ActiveSocketSource(Handle const & handle);
+                                        ///< Create new reader for the given handle
                                         /**< Data will be read from \a handle and be parsed by \a
                                              Reader.
                                              \pre Requires \a Reader to be default constructible
                                              \param[in] handle Handle to read data from */
-        ActiveSocketSource(Handle handle, Reader reader);
+        ActiveSocketSource(Handle const & handle, Reader reader);
                                         ///< Create new reader for the given handle
                                         /**< Data will be read from \a handle and be parsed by \a
                                              Reader.
@@ -136,24 +142,61 @@ namespace module {
 
         Reader & reader();              ///< Access Reader helper
         Handle handle();                ///< Access handle
-        void handle(Handle handle);     ///< Set handle
+        void handle(Handle const & handle);
+                                        ///< Set handle
                                         /**< Assigning an empty or in-valid() handle will disable
                                              the module until a new, valid handle is assigned. */
 
-        bool enabled();                 ///< Check is the IOEvent of the Source is enabled
-        void enabled( bool state);      ///< Change the state of the Source's IOEvent
-
     private:
+        Handle handle_;
+        IOEvent event_;
+        Reader reader_;
+
         void read();
+    };
+
+
+    template <class Reader=DgramReader<> >
+    class ActiveBurstSocketSource
+        : public Module
+    {
+        SENF_PPI_MODULE(ActiveBurstSocketSource);
+
+    public:
+        typedef typename Reader::Handle Handle; ///< Handle type requested by the reader
+
+        connector::ActiveOutput<typename Reader::PacketType> output;
+                                        ///< Output connector to which the data received is written
+
+        ActiveBurstSocketSource(unsigned max_burst=0);
+        explicit ActiveBurstSocketSource(Reader reader, unsigned max_burst=0);
+        explicit ActiveBurstSocketSource(Handle const & handle, unsigned max_burst=0);
+        ActiveBurstSocketSource(Handle const & handle, Reader reader, unsigned max_burst=0);
+
+        Reader & reader();              ///< Access Reader helper
+        Handle handle();                ///< Access handle
+        void handle(Handle const & handle);
+                                        ///< Set handle
+                                        /**< Assigning an empty or in-valid() handle will disable
+                                             the module until a new, valid handle is assigned. */
+
+        unsigned maxBurst() const;
+        void maxBurst(unsigned max_burst);
 
+        void flush();
+
+    private:
         Handle handle_;
         IOEvent event_;
         Reader reader_;
+        unsigned maxBurst_;
+
+        void read();
     };
 
 }}}
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 //#include "SocketSource.cci"
 #include "SocketSource.ct"
 #include "SocketSource.cti"