switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / PPI / SocketSink.hh
index ab68990..a815e5f 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 SocketSink public header */
@@ -39,7 +44,7 @@
 #include "IOEvent.hh"
 
 //#include "SocketSink.mpp"
-///////////////////////////////hh.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 namespace ppi {
@@ -58,7 +63,7 @@ namespace ppi {
                                         ///< Handle type supported by this writer
         typedef Packet PacketType;
 
-        bool operator()(Handle handle, Packet const & packet);
+        bool operator()(Handle & handle, Packet const & packet);
                                         ///< Write \a packet to \a handle
                                         /**< Write the complete \a packet as a datagram to \a
                                              handle.
@@ -87,7 +92,7 @@ namespace ppi {
         typename Handle::Address target() const; ///< Get current target address
         void target(typename Handle::Address const & target); ///< Set target address
 
-        bool operator()(Handle handle, Packet const & packet); ///< Write \a packet to \a handle
+        bool operator()(Handle & handle, Packet const & packet); ///< Write \a packet to \a handle
                                         /**< Write the complete \a packet as a datagram to \a
                                              handle.
                                              \param[in] handle Handle to write data to
@@ -113,7 +118,7 @@ namespace ppi {
         void destination(senf::INet4SocketAddress & dest);
         senf::INet4SocketAddress destination();
 
-        bool operator()(Handle handle, Packet const & packet);
+        bool operator()(Handle & handle, Packet const & packet);
                                         ///< Write \a packet to \a handle
                                         /**< Write the complete \a packet as a datagram to \a
                                              handle.
@@ -142,7 +147,7 @@ namespace ppi {
         void destination(senf::INet6SocketAddress & dest);
         senf::INet6SocketAddress destination();
 
-        bool operator()(Handle handle, Packet const & packet);
+        bool operator()(Handle & handle, Packet const & packet);
                                         ///< Write \a packet to \a handle
                                         /**< Write the complete \a packet as a datagram to \a
                                              handle.
@@ -210,11 +215,12 @@ namespace module {
                                              \pre Requires \a Writer to be copy constructible
                                              \param[in] writer Writer helper writing packet date to
                                                  the socket */
-        explicit ActiveSocketSink(Handle handle); ///< Create new writer for the given handle
+        explicit ActiveSocketSink(Handle const & handle);
+                                        ///< Create new writer for the given handle
                                         /**< Data will be written to \a handle using \a Writer.
                                              \pre Requires \a Writer to be default constructible
                                              \param[in] handle Handle to write data to */
-        ActiveSocketSink(Handle handle, Writer const & writer);
+        ActiveSocketSink(Handle const & handle, Writer const & writer);
                                         ///< Create new writer for the given handle
                                         /**< Data will be written to \a handle using \a Writer.
                                              \pre Requires \a Writer to be copy constructible
@@ -224,7 +230,8 @@ namespace module {
 
         Writer & writer();              ///< Access the Writer
         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. */
 
@@ -286,11 +293,12 @@ namespace module {
                                              \pre Requires \a Writer to be copy constructible
                                              \param[in] writer Writer helper writing packet date to
                                                  the socket */
-        explicit PassiveSocketSink(Handle handle); ///< Create new writer for the given handle
+        explicit PassiveSocketSink(Handle const & handle);
+                                        ///< Create new writer for the given handle
                                         /**< Data will be written to \a handle using \a Writer.
                                              \pre Requires \a Writer to be default constructible
                                              \param[in] handle Handle to write data to */
-        PassiveSocketSink(Handle handle, Writer const & writer);
+        PassiveSocketSink(Handle const & handle, Writer const & writer);
                                         ///< Create new writer for the given handle
                                         /**< Data will be written to \a handle using \a Writer.
                                              \pre Requires \a Writer to be copy constructible
@@ -300,7 +308,8 @@ namespace module {
 
         Writer & writer();              ///< Access the Writer
         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. */
 
@@ -319,7 +328,7 @@ namespace module {
 }}}
 
 
-///////////////////////////////hh.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #include "SocketSink.cci"
 #include "SocketSink.ct"
 #include "SocketSink.cti"