Again some doc-build fixes
[senf.git] / Socket / FileHandle.cc
index 4865ae6..c482e6d 100644 (file)
@@ -20,7 +20,9 @@
 // Free Software Foundation, Inc.,
 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
-// Definition of non-inline non-template functions
+/** \file
+    \brief senf::FileHandle non-inline non-template implementation
+ */
 
 #include "FileHandle.hh"
 //#include "FileHandle.ih"
 #define prefix_
 ///////////////////////////////cc.p////////////////////////////////////////
 
-prefix_ void satcom::lib::FileBody::v_close()
+prefix_ void senf::FileBody::v_close()
 {
     if (::close(fd_) != 0)
         throw SystemException(errno);
 }
 
-prefix_ void satcom::lib::FileBody::v_terminate()
+prefix_ void senf::FileBody::v_terminate()
 {
     ::close(fd_);
 }
 
-prefix_ bool satcom::lib::FileBody::v_eof()
+prefix_ bool senf::FileBody::v_eof()
     const
 {
     return false;
 }
 
-prefix_ bool satcom::lib::FileBody::v_valid()
+prefix_ bool senf::FileBody::v_valid()
     const
 {
     return true;
 }
 
-prefix_ bool satcom::lib::FileBody::blocking()
+prefix_ bool senf::FileBody::blocking()
     const
 {
     int flags = ::fcntl(fd(),F_GETFL);
@@ -67,7 +69,7 @@ prefix_ bool satcom::lib::FileBody::blocking()
     return ! (flags & O_NONBLOCK);
 }
 
-prefix_ void satcom::lib::FileBody::blocking(bool status)
+prefix_ void senf::FileBody::blocking(bool status)
 {
     int flags = ::fcntl(fd(),F_GETFL);
     if (flags < 0) throw SystemException(errno);
@@ -76,7 +78,10 @@ prefix_ void satcom::lib::FileBody::blocking(bool status)
     if (::fcntl(fd(), F_SETFL, flags) < 0) throw SystemException(errno);
 }
 
-prefix_ bool satcom::lib::FileBody::pollCheck(int fd, bool incoming, bool block)
+/* We don't take POLLIN/POLLOUT as argument to avoid having to include
+   sys/poll.h in the .cci file (and therefore indirectly into the .hh
+   and then every file which uses FileHandle) */
+prefix_ bool senf::FileBody::pollCheck(int fd, bool incoming, bool block)
     const
 {
     struct ::pollfd pfd;
@@ -103,5 +108,5 @@ prefix_ bool satcom::lib::FileBody::pollCheck(int fd, bool incoming, bool block)
 \f
 // Local Variables:
 // mode: c++
-// c-file-style: "satcom"
+// c-file-style: "senf"
 // End: