X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=senf%2FSocket%2FFileHandle.hh;h=b9abd4716b5473f3eac433e7e06e57e30cdeec5e;hb=23a1bdee20b3fb19bd442efed8aa73b2bf0d585a;hp=0667051cdfa84f641431e27bab357c1d9be74007;hpb=4d7356cbd92801bc0c4bec27fffe3b0024807185;p=senf.git diff --git a/senf/Socket/FileHandle.hh b/senf/Socket/FileHandle.hh index 0667051..b9abd47 100644 --- a/senf/Socket/FileHandle.hh +++ b/senf/Socket/FileHandle.hh @@ -2,30 +2,35 @@ // // Copyright (C) 2006 // Fraunhofer Institute for Open Communication Systems (FOKUS) -// Competence Center NETwork research (NET), St. Augustin, GERMANY -// Stefan Bund // -// 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. +// The contents of this file are subject to the Fraunhofer FOKUS Public License +// Version 1.0 (the "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// http://senf.berlios.de/license.html // -// 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. +// The Fraunhofer FOKUS Public License Version 1.0 is based on, +// but modifies the Mozilla Public License Version 1.1. +// See the full license text for the amendments. // -// 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. +// Software distributed under the License is distributed on an "AS IS" basis, +// WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License +// for the specific language governing rights and limitations under the License. +// +// The Original Code is Fraunhofer FOKUS code. +// +// The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V. +// (registered association), Hansastraße 27 c, 80686 Munich, Germany. +// All Rights Reserved. +// +// Contributor(s): +// Stefan Bund /** \file \brief FileHandle public header */ /** \defgroup handle_group The Handle Hierarchy - + \diaimage FhHierarchy.dia The senf::FileHandle class is the base of a hierarchy of socket handle classes (realized as @@ -63,13 +68,13 @@ #include //#include "FileHandle.mpp" -///////////////////////////////hh.p//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #include "FileHandle.ih" namespace senf { /// \addtogroup handle_group - /// @{ + //\{ /** \brief Basic file handle wrapper @@ -104,12 +109,12 @@ namespace senf { : public safe_bool { public: - /////////////////////////////////////////////////////////////////////////// + //-//////////////////////////////////////////////////////////////////////// // Types - /////////////////////////////////////////////////////////////////////////// + //-//////////////////////////////////////////////////////////////////////// ///\name Structors and default members - ///@{ + //\{ FileHandle(); ~FileHandle(); @@ -121,8 +126,8 @@ namespace senf { // no conversion constructors - ///@} - /////////////////////////////////////////////////////////////////////////// + //\} + //-//////////////////////////////////////////////////////////////////////// void close(); ///< Close filehandle /**< \throws senf::SystemException */ @@ -130,11 +135,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 @@ -143,16 +148,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. */ @@ -217,11 +222,11 @@ namespace senf { */ int retrieve_filehandle(FileHandle handle); - /// @} + //\} } -///////////////////////////////hh.e//////////////////////////////////////// +//-///////////////////////////////////////////////////////////////////////////////////////////////// #include "FileHandle.cci" //#include "FileHandle.ct" //#include "FileHandle.cti"