X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FSocket%2FFileHandle.hh;h=526cb635de68393b9da1828c797f41bc8c367d0c;hb=0e87ffe1cd4de41a27a29c427d7538789e4e3a43;hp=6b9bfb9a7d8f7eb87ea3d7d43441cc69d0238160;hpb=26610f603ebdd465307b9621f532c1fe19fd5571;p=senf.git diff --git a/senf/Socket/FileHandle.hh b/senf/Socket/FileHandle.hh index 6b9bfb9..526cb63 100644 --- a/senf/Socket/FileHandle.hh +++ b/senf/Socket/FileHandle.hh @@ -26,15 +26,7 @@ /** \defgroup handle_group The Handle Hierarchy -
- \ref SocketHandle - \ref ClientSocketHandle - \ref ProtocolClientSocketHandle - \ref ProtocolServerSocketHandle - \ref FileHandle - \ref ServerSocketHandle -
- \htmlonly FhHierarchy \endhtmlonly + \diaimage FhHierarchy.dia The senf::FileHandle class is the base of a hierarchy of socket handle classes (realized as templates). These classes provide an interface to the complete socket API. While going down the @@ -71,13 +63,13 @@ #include //#include "FileHandle.mpp" -///////////////////////////////hh.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #include "FileHandle.ih" namespace senf { /// \addtogroup handle_group - /// @{ + //\{ /** \brief Basic file handle wrapper @@ -112,12 +104,12 @@ namespace senf { : public safe_bool { public: - /////////////////////////////////////////////////////////////////////////// + //-//////////////////////////////////////////////////////////////////////// // Types - /////////////////////////////////////////////////////////////////////////// + //-//////////////////////////////////////////////////////////////////////// ///\name Structors and default members - ///@{ + //\{ FileHandle(); ~FileHandle(); @@ -129,8 +121,8 @@ namespace senf { // no conversion constructors - ///@} - /////////////////////////////////////////////////////////////////////////// + //\} + //-//////////////////////////////////////////////////////////////////////// void close(); ///< Close filehandle /**< \throws senf::SystemException */ @@ -138,11 +130,11 @@ namespace senf { bool readable() const; ///< Check, whether a read on the handle would not block ///< (ignoring blocking state) - bool waitReadable(senf::ClockService::clock_type timeout = -1) const; + bool waitReadable(senf::ClockService::clock_type timeout = -1) const; ///< Wait, until read on the handle would not block (ignoring ///< blocking state) /**< \param[in] timeout max time to wait, default is to wait - forever. + forever. \returns \c true, if handle became readable or \c false on timeout. */ bool writeable() const; ///< Check, whether a write on the handle would not block @@ -151,16 +143,16 @@ namespace senf { ///< Wait, until a write on the handle would not block ///< (ignoring blocking state) /**< \param[in] timeout max time to wait, default is to wait - forever. + forever. \returns \c true, if handle became writable or \c false on timeout. */ - bool oobReadable() const; ///< Check, whether a read of prioritized data on the handle + bool oobReadable() const; ///< Check, whether a read of prioritized data on the handle ///< would not block (ignoring blocking state) - bool waitOOBReadable(senf::ClockService::clock_type timeout = -1) const; + bool waitOOBReadable(senf::ClockService::clock_type timeout = -1) const; ///< Wait, until read of prioritized data on the handle does ///< not block (ignoring blocking state) /**< \param[in] timeout max time to wait, default is to wait - forever. + forever. \returns \c true, if handle became readable for out-of-band data or \c false on timeout. */ @@ -225,11 +217,11 @@ namespace senf { */ int retrieve_filehandle(FileHandle handle); - /// @} + //\} } -///////////////////////////////hh.e//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #include "FileHandle.cci" //#include "FileHandle.ct" //#include "FileHandle.cti"