Socket/BufferingPolicy.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   5 // Kompetenzzentrum fuer Satelitenkommunikation (SatCom)
   6 //     Stefan Bund <stefan.bund@fokus.fraunhofer.de>
   7 //
   8 // This program is free software; you can redistribute it and/or modify
   9 // it under the terms of the GNU General Public License as published by
  10 // the Free Software Foundation; either version 2 of the License, or
  11 // (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful,
  14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 // GNU General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the
  20 // Free Software Foundation, Inc.,
  21 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22
  23 /** \file
  24     \brief BufferingPolicy public header
  25  */
  26
  27 #ifndef HH_BufferingPolicy_
  28 #define HH_BufferingPolicy_ 1
  29
  30 // Custom includes
  31 #include "FileHandle.hh"
  32 #include "SocketPolicy.hh"
  33
  34 //#include "BufferingPolicy.mpp"
  35 ///////////////////////////////hh.p////////////////////////////////////////
  36
  37 namespace senf {
  38
  39     /// \addtogroup policy_impl_group
  40     /// @{
  41
  42     /** \brief BufferingPolicy implementing standard socket buffering
  43
  44         This policy class implements standard BSD socket buffering.
  45
  46         \todo Shouldn't this be dependent on Read / WritePolicy ?
  47      */
  48     struct SocketBufferingPolicy : public BufferingPolicyBase
  49     {
  50         static unsigned rcvbuf(FileHandle handle);
  51                                         ///< Check receive buffer size
  52                                         /**< \param[in] handle socket handle to check
  53                                              \returns size of receive buffer in bytes */
  54         static void rcvbuf(FileHandle handle, unsigned size);
  55                                         ///< Change receive buffer size
  56                                         /**< \param[in] handle socket handle
  57                                              \param[in] size new receive buffer size */
  58
  59         static unsigned sndbuf(FileHandle handle);
  60                                         ///< Check send buffer size
  61                                         /**< \param[in] handle socket handle to check
  62                                              \returns size of send buffer in bytes */
  63         static void sndbuf(FileHandle handle, unsigned size);
  64                                         ///< Change size of send buffer
  65                                         /**< \param[in] handle socket handle
  66                                              \param[in] size new send buffer size */
  67     };
  68
  69     /// @}
  70
  71 }
  72
  73 ///////////////////////////////hh.e////////////////////////////////////////
  74 //#include "BufferingPolicy.cci"
  75 //#include "BufferingPolicy.ct"
  76 //#include "BufferingPolicy.cti"
  77 //#include "BufferingPolicy.mpp"
  78 #endif
  79
  80 \f
  81 // Local Variables:
  82 // mode: c++
  83 // c-file-style: "senf"
  84 // fill-column: 100
  85 // End: