X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FSocket%2FFileHandle.hh;h=50ddaaf7e1327aefd1c58d99b6770916f130ed35;hb=c505c034e5fdc932c02aa3dc3847a5551011d87e;hp=377a8a61fbd9b036928e0af3e7c825fe1e614ba9;hpb=601d1f509f5bb24df167a4dd5a20da67a0af9af8;p=senf.git diff --git a/senf/Socket/FileHandle.hh b/senf/Socket/FileHandle.hh index 377a8a6..50ddaaf 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 @@ -67,8 +59,8 @@ // Custom includes #include // std::auto_ptr -#include "../Utils/safe_bool.hh" -#include "../Scheduler/ClockService.hh" +#include +#include //#include "FileHandle.mpp" ///////////////////////////////hh.p//////////////////////////////////////// @@ -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. */