X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=Socket%2FClientSocketHandle.ih;h=f752e7b9fa518593ac83ddd6bb2b67e072b4e653;hb=3863d46dd898b7bc35ea8c6ccd8563b18762a6b6;hp=e970c1a1629db886507baf8beb1f277eaae44e57;hpb=31d85cd6b8e03c5ecc924ca8892906be1bab702f;p=senf.git

diff --git a/Socket/ClientSocketHandle.ih b/Socket/ClientSocketHandle.ih
index e970c1a..f752e7b 100644
--- a/Socket/ClientSocketHandle.ih
+++ b/Socket/ClientSocketHandle.ih
@@ -1,6 +1,8 @@
-// Copyright (C) 2007 
-// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
-// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
+// $Id$
+//
+// Copyright (C) 2007
+// 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
@@ -21,11 +23,11 @@
 /** \file
     \brief ClientSocketHandle internal header */
 
-#ifndef IH_ClientSocketHandle_
-#define IH_ClientSocketHandle_ 1
+#ifndef IH_SENF_Socket_ClientSocketHandle_
+#define IH_SENF_Socket_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////////////////////////////////////////
@@ -93,4 +117,5 @@ namespace detail {
 // indent-tabs-mode: nil
 // ispell-local-dictionary: "american"
 // compile-command: "scons -u test"
+// comment-column: 40
 // End: