Finished libSocket and libUtils documentation

[senf.git] / Scheduler / ReadHelper.ct

diff --git a/Scheduler/ReadHelper.ct b/Scheduler/ReadHelper.ct
index 16d2850..83a557a 100644 (file)
--- a/Scheduler/ReadHelper.ct
+++ b/Scheduler/ReadHelper.ct
@@ -1,8 +1,25 @@
 // $Id$
 //
+// Copyright (C) 2006 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
+// the Free Software Foundation; either version 2 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with this program; if not, write to the
+// Free Software Foundation, Inc.,
+// 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 // Copyright (C) 2006 
 
-// Definition of non-inline template functions
+/** \file
+    \brief ReadHelper non-inline template implementation */
 
 #include "ReadHelper.ih"
 
@@ -16,7 +33,7 @@
 ///////////////////////////////ct.p////////////////////////////////////////
 
 template <class Handle>
-prefix_ satcom::lib::ReadHelper<Handle>::ReadHelper(Handle handle, std::string::size_type maxSize,
+prefix_ senf::ReadHelper<Handle>::ReadHelper(Handle handle, std::string::size_type maxSize,
                                                     InternalPredicate * predicate, Callback cb)
     : handle_(handle), maxSize_(maxSize), predicate_(predicate), callback_(cb), 
       errno_(0), complete_(false)
@@ -25,23 +42,23 @@ prefix_ satcom::lib::ReadHelper<Handle>::ReadHelper(Handle handle, std::string::
     // argumnet instead of a simple bound-member as callback to the
     // scheduler. This ensures, that the refcount is at least 1 as
     // long as the helper is registered with the scheduler.
-    satcom::lib::Scheduler::instance()
+    senf::Scheduler::instance()
        .add(handle,boost::bind(&ReadHelper::dispatchProcess,ptr(this),_1,_2),
-            satcom::lib::Scheduler::EV_READ);
+            senf::Scheduler::EV_READ);
 }
 
 template <class Handle>
-prefix_ void satcom::lib::ReadHelper<Handle>::revoke()
+prefix_ void senf::ReadHelper<Handle>::revoke()
 {
     ptr guard (this); // To ensure, 'this' is deleted only after this method terminates ...
-    satcom::lib::Scheduler::instance()
-       .remove(handle_,satcom::lib::Scheduler::EV_READ);
+    senf::Scheduler::instance()
+       .remove(handle_,senf::Scheduler::EV_READ);
 }
 
 template <class Handle>
 prefix_ void
-satcom::lib::ReadHelper<Handle>::dispatchProcess(ptr helper, Handle handle,
-                                                 satcom::lib::Scheduler::EventId event)
+senf::ReadHelper<Handle>::dispatchProcess(ptr helper, Handle handle,
+                                                 senf::Scheduler::EventId event)
 {
     // since we have a 'ptr' argument, the instance cannot be deleted
     // before this method returns
@@ -49,11 +66,12 @@ satcom::lib::ReadHelper<Handle>::dispatchProcess(ptr helper, Handle handle,
 }
 
 template <class Handle>
-prefix_ void satcom::lib::ReadHelper<Handle>::process(Handle handle,
-                                                      satcom::lib::Scheduler::EventId event)
+prefix_ void senf::ReadHelper<Handle>::process(Handle handle,
+                                                      senf::Scheduler::EventId event)
 {
+    /** \fixme Move the done() calls to outside the try/catch block */
     try {
-       if (event != satcom::lib::Scheduler::EV_READ)
+       if (event != senf::Scheduler::EV_READ)
            throw SystemException(EPIPE);
        std::string rcv (handle.read(maxSize_ - data_.size()));
        data_.append(rcv);
@@ -67,14 +85,14 @@ prefix_ void satcom::lib::ReadHelper<Handle>::process(Handle handle,
            done();
        }
     }
-    catch (satcom::lib::SystemException const & ex) {
+    catch (senf::SystemException const & ex) {
        errno_ = ex.err;
        done();
     }
 }
 
 template <class Handle>
-prefix_ void satcom::lib::ReadHelper<Handle>::done()
+prefix_ void senf::ReadHelper<Handle>::done()
 {
     revoke();
     callback_(ptr(this));
@@ -83,7 +101,7 @@ prefix_ void satcom::lib::ReadHelper<Handle>::done()
 template <class Handle>
 template <class Predicate>
 prefix_ std::string::size_type
-satcom::lib::ReadHelper<Handle>::InternalPredicate::Dispatcher<Predicate>::
+senf::ReadHelper<Handle>::InternalPredicate::Dispatcher<Predicate>::
 operator()(std::string const & data)
 {
     return predicate(data);