X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FCommunicationPolicy.hh;h=47dc01f57943efd0c259d0681a7292002910baf7;hb=92f8630b75f3ef50e73c48cde58645dcd1534e27;hp=4d8cdce77588407939f36112eae0e1e27b1e3d78;hpb=ac6a813d9d99f7add4e13aff7a4bcd314d5604a6;p=senf.git

diff --git a/Socket/CommunicationPolicy.hh b/Socket/CommunicationPolicy.hh
index 4d8cdce..47dc01f 100644
--- a/Socket/CommunicationPolicy.hh
+++ b/Socket/CommunicationPolicy.hh
@@ -1,9 +1,9 @@
 // $Id$
 //
-// Copyright (C) 2006 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
-//     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
+// 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
@@ -20,8 +20,12 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-#ifndef HH_CommunicationPolicy_
-#define HH_CommunicationPolicy_ 1
+/** \file
+    \brief CommunicationPolicy public header
+ */
+
+#ifndef HH_SENF_Socket_CommunicationPolicy_
+#define HH_SENF_Socket_CommunicationPolicy_ 1
 
 // Custom includes
 #include "SocketPolicy.hh"
@@ -35,28 +39,83 @@ struct sockaddr;
 
 namespace senf {
 
-    
-    template <class Policy> class ServerSocketHandle;
+    /// \addtogroup policy_impl_group
+    /// @{
+
+    template <class SPolicy> class ServerSocketHandle;
+
+    /** \brief CommunicationPolicy for connected sockets
 
+        The ConnectedCommunicationPolicy provides support for standard BSD socket API based
+        connected communication. It provides the server side listen() and accept() members.
+     */
     struct ConnectedCommunicationPolicy : public CommunicationPolicyBase
     {
-        static void listen(FileHandle handle, unsigned backlog);
-        template <class Policy>
-        static int accept(ServerSocketHandle<Policy> handle, 
-                          typename ServerSocketHandle<Policy>::Address & address,
-                          typename IfAddressingPolicyIsNot<Policy,NoAddressingPolicy>::type * = 0);
+#       ifndef DOXYGEN
+        template <class SPolicy>
+        static void listen(ServerSocketHandle<SPolicy> handle, unsigned backlog,
+                           typename IfAddressingPolicyIsNot<SPolicy,NoAddressingPolicy>::type * = 0);
+#       else
+        template <class SPolicy>
+        static void listen(ServerSocketHandle<SPolicy> handle, unsigned backlog);
+                                        ///< Enable establishing new connections on the socket
+                                        /**< \param[in] handle socket handle to enable reception on
+                                             \param[in] backlog size of backlog queue */
+#       endif
+
+#       ifndef DOXYGEN
+        template <class SPolicy>
+        static int accept(ServerSocketHandle<SPolicy> handle,
+                          typename ServerSocketHandle<SPolicy>::Address & address,
+                          typename IfAddressingPolicyIsNot<SPolicy,NoAddressingPolicy>::type * = 0);
+#       else
+        template <class SPolicy>
+        static int accept(ServerSocketHandle<SPolicy> handle,
+                          typename ServerSocketHandle<SPolicy>::Address & address);
+                                        ///< accept a new connection on the socket.
+                                        /**< The accept() member will return a new client file
+                                             descriptor. This file descriptor will be used by the
+                                             ServerSocketHandle implementation to build a new
+                                             ClientSocketHandle for the new connection.
+
+                                             \param[in] handle socket handle to accept connection on
+                                             \param[out] address address of newly connected remote
+                                                 peer
+                                             \returns file descriptor of new client socket */
+#       endif
+
+        static int accept(FileHandle handle);
+                                        ///< accept a new connection on the socket.
+                                        /**< The accept() member will return a new client file
+                                             descriptor. This file descriptor will be used by the
+                                             ServerSocketHandle implementation to build a new
+                                             ClientSocketHandle for the new connection.
+
+                                             \param[in] handle socket handle to accept connection on
+                                             \returns file descriptor of new client socket */
+
     private:
+        static void do_listen(FileHandle handle, unsigned backlog);
         static int do_accept(FileHandle handle, struct sockaddr * addr, unsigned len);
     };
 
+    /** \brief CommunicationPolicy for unconnected sockets
+
+        This is different from UndefinedCommunicationPolicy (which is the same as
+        CommunicationPolicyBase). This policy class defines the communication policy -- it
+        explicitly states, that the socket does not support connected communication. This
+        effectively disables the ServerSocketHandle.
+     */
     struct UnconnectedCommunicationPolicy : public CommunicationPolicyBase
     {};
 
+    /// @}
+
 }
 
 
 ///////////////////////////////hh.e////////////////////////////////////////
-//#include "CommunicationPolicy.cci"
+#include "CommunicationPolicy.cci"
 //#include "CommunicationPolicy.ct"
 #include "CommunicationPolicy.cti"
 #endif
@@ -64,5 +123,10 @@ namespace senf {
 
 // Local Variables:
 // mode: c++
+// fill-column: 100
 // c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
 // End: