NEW FILE HEADER / COPYRIGHT FORMAT
[senf.git] / Socket / ServerSocketHandle.hh
index 445505e..22e9cb9 100644 (file)
@@ -1,9 +1,9 @@
-// $Id$
+// $Id:ServerSocketHandle.hh 218 2007-03-20 14:39:32Z tho $
 //
 // Copyright (C) 2006
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// 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
@@ -84,8 +84,9 @@ namespace senf {
         typedef typename Policy::AddressingPolicy::Address Address;
         /// 'Best' type for passing address as parameter
         /** Depending on the type of \c Address, this will be either <tt>Address</tt> or <tt>Address
-            const &</tt>. See <a href="http://www.boost.org/libs/utility/call_traits.htm"
-            class="ext">call_traits documentation in the Boost.Utility library\endlink.</a>
+            const &</tt>. See <a
+            href="http://www.boost.org/libs/utility/call_traits.htm">call_traits documentation in
+            the Boost.Utility library.</a>
          */
         typedef typename boost::call_traits<Address>::param_type AddressParam;
         /// Corresponding client socket handle with the same policy
@@ -95,11 +96,14 @@ namespace senf {
         ///\name Structors and default members
         ///@{
 
-        // no default constructor
+        // default default constructor
         // default copy constructor
         // default copy assignment
         // default destructor
 
+        // here to implement
+        ServerSocketHandle();
+
         // conversion constructors
         template <class OtherPolicy>
         ServerSocketHandle(ServerSocketHandle<OtherPolicy> other,
@@ -121,7 +125,7 @@ namespace senf {
             For addressable protocols (AddressingPolicy is not NoAddressingPolicy), bind() will set
             the local address of the socket.
 
-            \param[in] addr Local socket address to asign
+            \param[in] addr Local socket address to assign
 
             \throws senf::SystemException
          */
@@ -158,9 +162,8 @@ namespace senf {
 
         /** \brief Accept new connection
 
-            If the handle is non-blocking, accept will NOT block. If no connection
-            is available to be returned, accept will return a ClientSocketHandle
-            which is not valid()
+            If the handle is non-blocking, accept will NOT block. If no connection is available to
+            be returned, accept will return a ClientSocketHandle which is not valid()
 
             \throws senf::SystemException
 
@@ -182,7 +185,7 @@ namespace senf {
                                         ///< Accept new connection
                                         /**< This variant will additionally return the remote
                                            address of the client
-                                           \param[out] client address
+                                           \param[out] addr address
                                            \returns handle of new client connection
                                            \see \ref accept() */
 
@@ -219,4 +222,6 @@ namespace senf {
 // c-file-style: "senf"
 // indent-tabs-mode: nil
 // ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
 // End: