switch to new MPL based Fraunhofer FOKUS Public License
[senf.git] / senf / Socket / SocketHandle.ih
index de34df0..2b35e85 100644 (file)
@@ -2,23 +2,28 @@
 //
 // Copyright (C) 2006
 // 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 SocketHandle internal header
@@ -33,7 +38,7 @@
 #include <boost/scoped_ptr.hpp>
 #include "FileHandle.hh"
 
-///////////////////////////////ih.p////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 
 namespace senf {
 
@@ -60,10 +65,10 @@ namespace senf {
 
             template <class T>
             StreamableString & operator<<(T const & other);
-                                        ///< Value assigment
+                                        ///< Value assignment
                                         /**< This operator will assign the string from any
                                              arbitrary type. It will use boost::lexical_cast to
-                                             convert the argument to its string representation. 
+                                             convert the argument to its string representation.
 
                                              If the string is non-empty, an additional separating
                                              comma is added to the string. */
@@ -100,14 +105,14 @@ namespace senf {
         : public FileBody
     {
     public:
-        ///////////////////////////////////////////////////////////////////////////
+        //-/////////////////////////////////////////////////////////////////////////////////////////
         // Types
 
         typedef boost::intrusive_ptr<SocketBody> ptr;
 
-        ///////////////////////////////////////////////////////////////////////////
+        //-/////////////////////////////////////////////////////////////////////////////////////////
         ///\name Structors and default members
-        ///@{
+        //\{
 
         SocketBody(bool isServer);      /**< \param isServer \c true, if this socket is a server
                                              socket, false otherwise */
@@ -119,8 +124,8 @@ namespace senf {
         // no copy
         // no conversion constructors
 
-        ///@}
-        ///////////////////////////////////////////////////////////////////////////
+        //\}
+        //-/////////////////////////////////////////////////////////////////////////////////////////
 
         SocketProtocol & protocol() const; ///< Access the protocol instance
 
@@ -139,12 +144,12 @@ namespace senf {
                                            socket whenever it is closed.
                                            \throws senf::SystemException */
         virtual void v_terminate();     ///< Forcibly close socket
-                                        /**< This override will automatically \c shutfown() the
+                                        /**< This override will automatically \c shutdown() the
                                            socket whenever it is called. Additionally it will
                                            disable SO_LINGER to ensure, that v_terminate will not
-                                           block. Like the overriden method, this member will ignore
-                                           failures and will never throw. It therefore safe to be
-                                           called from a destructor. */
+                                           block. Like the overridden method, this member will
+                                           ignore failures and will never throw. It therefore
+                                           safe to be called from a destructor. */
         virtual bool v_eof() const;     ///< Check for eof condition
                                         /**< Since the eof check for sockets is very protocol
                                            dependent, this member will forward the call to
@@ -157,8 +162,8 @@ namespace senf {
     };
 
     template <class SProtocol>
-    class ProtocolSocketBody 
-        : public SocketBody, 
+    class ProtocolSocketBody
+        : public SocketBody,
           private SProtocol,
           public senf::pool_alloc_mixin< ProtocolSocketBody<SProtocol> >
     {
@@ -174,7 +179,7 @@ namespace senf {
                                         /**< \param isServer \c true, if this socket is a server
                                              socket, false otherwise
                                              \param fd socket file descriptor */
-        
+
     private:
         virtual SocketProtocol const & v_protocol() const;
         virtual std::string v_protocolName() const;
@@ -184,7 +189,7 @@ namespace senf {
 
 }
 
-///////////////////////////////ih.e////////////////////////////////////////
+//-/////////////////////////////////////////////////////////////////////////////////////////////////
 #endif
 
 \f