X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FFramingPolicy.hh;h=3162b211a1ffe33fa93d3fc513ee59d7e5d3764d;hb=9a988902090d28007578e93bffd809f6bd913155;hp=97a440c263bc571ffc9d2a28d5d571e459a1d359;hpb=ac6a813d9d99f7add4e13aff7a4bcd314d5604a6;p=senf.git

diff --git a/Socket/FramingPolicy.hh b/Socket/FramingPolicy.hh
index 97a440c..3162b21 100644
--- a/Socket/FramingPolicy.hh
+++ b/Socket/FramingPolicy.hh
@@ -1,6 +1,6 @@
 // $Id$
 //
-// Copyright (C) 2006 
+// Copyright (C) 2006
 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
 //     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
@@ -20,6 +20,10 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
+/** \file
+    \brief FramingPolicy public header
+ */
+
 #ifndef HH_FramingPolicy_
 #define HH_FramingPolicy_ 1
 
@@ -31,13 +35,33 @@
 
 namespace senf {
 
+    /// \addtogroup policy_impl_group
+    /// @{
+
+    /** \brief FramingPolicy for stream oriented sockets
 
+        This policy does not explicitly modify the SocketHAndle
+        API. It however affects the semantics of the read and write
+        operations. On a stream oriented socket, read() and write()
+        operations may be combined, the boundary between separate
+        write() calls will be lost on the receiving side.
+     */
     struct StreamFramingPolicy : public FramingPolicyBase
     {};
 
+    /** \brief FramingPolicy for datagram oriented sockets
+
+        This policy does not explicitly modify the SocketHAndle
+        API. It however affects the semantics of the read and write
+        operations. On a datagram socket, each read() or write() call
+        we read or write a single datagram. Datagram boundaries are
+        kept intact accross the network.
+     */
     struct DatagramFramingPolicy : public FramingPolicyBase
     {};
 
+    /// @}
+
 }
 
 ///////////////////////////////hh.e////////////////////////////////////////
@@ -49,5 +73,8 @@ namespace senf {
 
 // Local Variables:
 // mode: c++
+// fill-column: 100
 // c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
 // End: