// $Id$
//
-// Copyright (C) 2006
+// Copyright (C) 2006
// Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
// Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
// Stefan Bund <stefan.bund@fokus.fraunhofer.de>
/** \brief FileHandle referenced body
-
- \internal
- The senf::FileBody class formes the body part of the handle/body structure of the FileHandle
- interface. It manages the FileHandle data and is referenced by senf::FileHandle. It is
- automatically managed using reference counting.
+ \internal
- Since the senf::FileHandle class forwards most calls directly to the underlying
- senf::FileBody instance, most members are documented in senf::FileHandle.
+ The senf::FileBody class formes the body part of the handle/body structure of the FileHandle
+ interface. It manages the FileHandle data and is referenced by senf::FileHandle. It is
+ automatically managed using reference counting.
- \section filebody_new Writing senf::FileBody derived classes
+ Since the senf::FileHandle class forwards most calls directly to the underlying
+ senf::FileBody instance, most members are documented in senf::FileHandle.
- It is possible to write customized senf::FileBody derived body implementations. This
- implementation can then be used be a senf::FileHandle derived class to customize the
- FileHandle behavior. Handling the body directly by the handle class ensures, that no invalid
- handles can be created (a senf::FileHandle derived handle expecting a specific body type but
- pointing to a different body type).
+ \section filebody_new Writing senf::FileBody derived classes
- To customize the behavior, a virtual interface is provided. This interface only covers some
- basic funcionality which is only used infrequently during the lifetime of a FileHandle
- instance.
+ It is possible to write customized senf::FileBody derived body implementations. This
+ implementation can then be used be a senf::FileHandle derived class to customize the
+ FileHandle behavior. Handling the body directly by the handle class ensures, that no invalid
+ handles can be created (a senf::FileHandle derived handle expecting a specific body type but
+ pointing to a different body type).
+
+ To customize the behavior, a virtual interface is provided. This interface only covers some
+ basic funcionality which is only used infrequently during the lifetime of a FileHandle
+ instance.
*/
class FileBody
public:
///////////////////////////////////////////////////////////////////////////
// Types
-
+
typedef boost::intrusive_ptr<FileBody> ptr;
///////////////////////////////////////////////////////////////////////////
///\name Structors and default members
///@{
-
- explicit FileBody(int fd=-1); ///< Create new instance
- /**< You need to pass a real file descriptor to this
- constructor not some arbitrary id even if you overload
- all the virtual members. If the file descriptor is -1 the
- resulting body/handle is not valid() */
+
+ explicit FileBody(int fd=-1); ///< Create new instance
+ /**< You need to pass a real file descriptor to this
+ constructor not some arbitrary id even if you overload
+ all the virtual members. If the file descriptor is -1 the
+ resulting body/handle is not valid() */
virtual ~FileBody();
// no copy
bool eof() const;
bool valid() const;
-
+
private:
///////////////////////////////////////////////////////////////////////////
// Virtual interface for subclasses to override
- virtual void v_close(); ///< Called to close the file descriptor
- /**< You should probably always call the global ::close()
- function in this member, however you might want to do
- some additional cleanup here. If the operation fails, you
- are allowed to throw (preferably a
- senf::SystemException).
-
- \throws senf::SystemException */
- virtual void v_terminate(); ///< Called to forcibly close the file descriptor
- /**< This member is called by the destructor (and by
- terminate()) to close the descriptor. This member must \e
- never throw, it should probably just ignore error
- conditions (there's not much else you can do) */
- virtual bool v_eof() const; ///< Called by eof()
- virtual bool v_valid() const; ///< Called by valid()
- /**< This member is only called, if the file descriptor is
- not -1 */
+ virtual void v_close(); ///< Called to close the file descriptor
+ /**< You should probably always call the global ::close()
+ function in this member, however you might want to do
+ some additional cleanup here. If the operation fails, you
+ are allowed to throw (preferably a
+ senf::SystemException).
+
+ \throws senf::SystemException */
+ virtual void v_terminate(); ///< Called to forcibly close the file descriptor
+ /**< This member is called by the destructor (and by
+ terminate()) to close the descriptor. This member must \e
+ never throw, it should probably just ignore error
+ conditions (there's not much else you can do) */
+ virtual bool v_eof() const; ///< Called by eof()
+ virtual bool v_valid() const; ///< Called by valid()
+ /**< This member is only called, if the file descriptor is
+ not -1 */
protected:
-
+
private:
bool pollCheck(int fd, bool incoming, bool block=false) const;
\f
// Local Variables:
// mode: c++
-// c-file-style: "senf"
// fill-column: 100
+// c-file-style: "senf"
+// indent-tabs-mode: nil
+// ispell-local-dictionary: "american"
// End:
projects / senf.git / blobdiff