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 for non-buffered sockets
  43
  44         This is different from UndefinedBufferingPolicy (which is the
  45         same as BufferingPolicyBase). This policy class defines the
  46         buffering policy -- it explicitly states, that the socket does not
  47         support buffering.
  48      */
  49     struct NoBufferingPolicy : public BufferingPolicyBase
  50     {};
  51
  52     /// @}
  53
  54
  55     /// \addtogroup policy_impl_group
  56     /// @{
  57
  58     /** \brief BufferingPolicy implementing standard socket buffering
  59
  60         This policy class implements standard BSD socket buffering.
  61
  62         \todo Shouldn't this be dependent on Read / WritePolicy ?
  63      */
  64     struct SocketBufferingPolicy : public BufferingPolicyBase
  65     {
  66         static unsigned rcvbuf(FileHandle handle);
  67                                         ///< Check receive buffer size
  68                                         /**< \param[in] handle socket handle to check
  69                                              \returns size of receive buffer in bytes */
  70         static void rcvbuf(FileHandle handle, unsigned size);
  71                                         ///< Change receive buffer size
  72                                         /**< \param[in] handle socket handle
  73                                              \param[in] size new receive buffer size */
  74
  75         static unsigned sndbuf(FileHandle handle);
  76                                         ///< Check send buffer size
  77                                         /**< \param[in] handle socket handle to check
  78                                              \returns size of send buffer in bytes */
  79         static void sndbuf(FileHandle handle, unsigned size);
  80                                         ///< Change size of send buffer
  81                                         /**< \param[in] handle socket handle
  82                                              \param[in] size new send buffer size */
  83     };
  84
  85     /// @}
  86
  87 }
  88
  89 ///////////////////////////////hh.e////////////////////////////////////////
  90 //#include "BufferingPolicy.cci"
  91 //#include "BufferingPolicy.ct"
  92 //#include "BufferingPolicy.cti"
  93 //#include "BufferingPolicy.mpp"
  94 #endif
  95
  96 \f
  97 // Local Variables:
  98 // mode: c++
  99 // fill-column: 100
 100 // c-file-style: "senf"
 101 // indent-tabs-mode: nil
 102 // ispell-local-dictionary: "american"
 103 // compile-command: "scons -u test"
 104 // comment-column: 40
 105 // End: