Socket/BufferingPolicy.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2006
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     Stefan Bund <g0dil@berlios.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     /** \brief BufferingPolicy implementing standard socket buffering
  53
  54         This policy class implements standard BSD socket buffering.
  55
  56         \todo Shouldn't this be dependent on Read / WritePolicy ?
  57      */
  58     struct SocketBufferingPolicy : public BufferingPolicyBase
  59     {
  60         static unsigned rcvbuf(FileHandle handle);
  61                                         ///< Check receive buffer size
  62                                         /**< \param[in] handle socket handle to check
  63                                              \returns size of receive buffer in bytes */
  64         static void rcvbuf(FileHandle handle, unsigned size);
  65                                         ///< Change receive buffer size
  66                                         /**< \param[in] handle socket handle
  67                                              \param[in] size new receive buffer size */
  68
  69         static unsigned sndbuf(FileHandle handle);
  70                                         ///< Check send buffer size
  71                                         /**< \param[in] handle socket handle to check
  72                                              \returns size of send buffer in bytes */
  73         static void sndbuf(FileHandle handle, unsigned size);
  74                                         ///< Change size of send buffer
  75                                         /**< \param[in] handle socket handle
  76                                              \param[in] size new send buffer size */
  77     };
  78
  79     /// @}
  80
  81 }
  82
  83 ///////////////////////////////hh.e////////////////////////////////////////
  84 //#include "BufferingPolicy.cci"
  85 //#include "BufferingPolicy.ct"
  86 //#include "BufferingPolicy.cti"
  87 //#include "BufferingPolicy.mpp"
  88 #endif
  89
  90 \f
  91 // Local Variables:
  92 // mode: c++
  93 // fill-column: 100
  94 // c-file-style: "senf"
  95 // indent-tabs-mode: nil
  96 // ispell-local-dictionary: "american"
  97 // compile-command: "scons -u test"
  98 // comment-column: 40
  99 // End: