Blocked revisions 580 via svnmerge

[senf.git] / Socket / BufferingPolicy.hh

diff --git a/Socket/BufferingPolicy.hh b/Socket/BufferingPolicy.hh
index 0260dbb..b871e37 100644 (file)
--- a/Socket/BufferingPolicy.hh
+++ b/Socket/BufferingPolicy.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,6 +20,10 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief BufferingPolicy public header
+ */
+
 #ifndef HH_BufferingPolicy_
 #define HH_BufferingPolicy_ 1
 
@@ -32,20 +36,48 @@
 
 namespace senf {
 
+    /// \addtogroup policy_impl_group
+    /// @{
+    
+    /** \brief BufferingPolicy for non-buffered sockets
+    
+        This is different from UndefinedBufferingPolicy (which is the
+        same as BufferingPolicyBase). This policy class defines the
+        buffering policy -- it explicitly states, that the socket does not
+        support buffering.
+     */
+    struct NoBufferingPolicy : public BufferingPolicyBase
+    {};
+    
+    /** \brief BufferingPolicy implementing standard socket buffering
 
-    /** \brief
+        This policy class implements standard BSD socket buffering.
 
-       \todo Shouldn't this be dependent on Read / WritePolicy ?
+        \todo Shouldn't this be dependent on Read / WritePolicy ?
      */
     struct SocketBufferingPolicy : public BufferingPolicyBase
     {
         static unsigned rcvbuf(FileHandle handle);
+                                        ///< Check receive buffer size
+                                        /**< \param[in] handle socket handle to check
+                                             \returns size of receive buffer in bytes */
         static void rcvbuf(FileHandle handle, unsigned size);
+                                        ///< Change receive buffer size
+                                        /**< \param[in] handle socket handle
+                                             \param[in] size new receive buffer size */
 
         static unsigned sndbuf(FileHandle handle);
+                                        ///< Check send buffer size
+                                        /**< \param[in] handle socket handle to check
+                                             \returns size of send buffer in bytes */
         static void sndbuf(FileHandle handle, unsigned size);
+                                        ///< Change size of send buffer
+                                        /**< \param[in] handle socket handle
+                                             \param[in] size new send buffer size */
     };
 
+    /// @}
+
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////
@@ -58,5 +90,10 @@ namespace senf {
 \f
 // 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: