NEW FILE HEADER / COPYRIGHT FORMAT

[senf.git] / Socket / ClientSocketHandle.ih

diff --git a/Socket/ClientSocketHandle.ih b/Socket/ClientSocketHandle.ih
index 6a08543..417ebc2 100644 (file)
--- a/Socket/ClientSocketHandle.ih
+++ b/Socket/ClientSocketHandle.ih
@@ -1,6 +1,8 @@
+// $Id$
+//
 // Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// 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
@@ -25,7 +27,7 @@
 #define IH_ClientSocketHandle_ 1
 
 // Custom includes
-#include "Utils/IteratorTraits.hh"
+#include "../Utils/IteratorTraits.hh"
 
 ///////////////////////////////ih.p////////////////////////////////////////
 
@@ -35,6 +37,13 @@ namespace detail {
     ///////////////////////////////////////////////////////////////////////
     // senf::detail::ReadRange
 
+    /** \brief Internal: Choose optimal read implementation
+
+        \internal
+
+        If the range iterator is a contiguous_storage_iterator, the data is *directly* read into the
+        range, otherwise a temporary storage area is used.
+     */
     template <class Handle, class ForwardWritableRange, bool IsContiguous>
     struct ReadRange 
     {
@@ -45,6 +54,8 @@ namespace detail {
         readfrom(Handle & handle, ForwardWritableRange & range, typename Handle::Address & addr);
     };
 
+#   ifndef DOXYGEN
+
     template <class Handle, class ForwardWritableRange>
     struct ReadRange<Handle, ForwardWritableRange, true>
     {
@@ -55,20 +66,31 @@ namespace detail {
         readfrom(Handle & handle, ForwardWritableRange & range, typename Handle::Address & addr);
     };
 
+#   endif
+
     ///////////////////////////////////////////////////////////////////////
     // senf::detail::WriteRange
 
+    /** \brief Internal: Choose optimal write implementation
+
+        \internal
+
+        If the range iterator is a contiguous_storage_iterator, the data is *directly* written from
+        the range, otherwise a temporary storage area is used.
+     */
     template <class Handle, class ForwardReadableRange, bool IsContiguous>
     struct WriteRange
     {
-        static typename boost::range_iterator<ForwardReadableRange>::type
+        static typename boost::range_const_iterator<ForwardReadableRange>::type
         write(Handle & handle, ForwardReadableRange & range);
         
-        static typename boost::range_iterator<ForwardReadableRange>::type
+        static typename boost::range_const_iterator<ForwardReadableRange>::type
         writeto(Handle & handle, ForwardReadableRange & range,
                 typename Handle::Address const & addr);
     };
 
+#   ifndef DOXYGEN
+
     template <class Handle, class ForwardReadableRange>
     struct WriteRange<Handle, ForwardReadableRange, true>
     {
@@ -80,6 +102,8 @@ namespace detail {
                 typename Handle::Address const & addr);
     };
 
+#   endif
+
 }}
 
 ///////////////////////////////ih.e////////////////////////////////////////
@@ -92,4 +116,6 @@ namespace detail {
 // c-file-style: "senf"
 // indent-tabs-mode: nil
 // ispell-local-dictionary: "american"
+// compile-command: "scons -u test"
+// comment-column: 40
 // End: