Socket/Protocols/BSDSocketProtocol.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 BSDSocketProtocol public header */
  25
  26 #ifndef HH_BSDSocketProtocol_
  27 #define HH_BSDSocketProtocol_ 1
  28
  29 // Custom includes
  30 #include "../../Socket/SocketProtocol.hh"
  31 #include <boost/cstdint.hpp>
  32
  33 //#include "BSDSocketProtocol.mpp"
  34 ///////////////////////////////hh.p////////////////////////////////////////
  35
  36 namespace senf {
  37
  38     /// \addtogroup protocol_facets_group
  39     /// @{
  40
  41     /** \brief Protocol facet providing basic BSD socket functionality
  42
  43         BSDSocketProtocol provides the basic BSD socket API as shared by all BSD sockets.
  44      */
  45     class BSDSocketProtocol
  46         : public virtual SocketProtocol
  47     {
  48     public:
  49         std::pair<bool,unsigned> linger() const; ///< Return current linger status
  50                                         /**< The value is returned in an std:pair. the first element
  51                                              is \c true, if linger is active. The second value is
  52                                              the linger timeout in seconds.
  53                                              \returns linger state (enable disabled) and linger
  54                                              timeout */
  55         void linger(bool enable, unsigned timeout=0) const; ///< Change linger status
  56                                         /**< If linger is enabled, the timeout value specifies, how
  57                                              long to wait before returning while data is unsent in
  58                                              seconds. If this value is 0, a close() might wait
  59                                              forever.
  60                                              \param[in] enable \c true to activate linger
  61                                              \param[in] timeout linger timeout in seconds */
  62        boost::uint8_t priority() const;  ///< Get packet priority assigned to outgoing packets
  63                                         /**< This call will return the priority value assigned to
  64                                              packets sent via this socket. Depending on the
  65                                              protocol, this value may also be placed inside the
  66                                              packet headers (for IPv4, this is the TOS value).
  67                                              \returns current socket priority */
  68         void priority(boost::uint8_t value) const; ///< Set packet priority (e.g. TOS)
  69                                         /**< Changes the packet queueing priority. Additionally may
  70                                              set protocol specific options. For IPv4 sockets, it
  71                                              sets the TOS field.
  72                                              \param[in] value new socket priority */
  73
  74         unsigned rcvbuf() const;        ///< Check receive buffer size
  75                                         /**< \returns size of receive buffer in bytes
  76                                              \internal Linux doubles the buffer size internally when
  77                                                  changing it to cater for additional space needed by
  78                                                  the linux kernel. This call will therefore return
  79                                                  only half the value reported by the kernel. */
  80         void rcvbuf(unsigned size) const; ///< Change receive buffer size
  81                                         /**< \param[in] size new receive buffer size */
  82
  83         unsigned sndbuf() const;        ///< Check send buffer size
  84                                         /**< \returns size of send buffer in bytes
  85                                              \internal Linux doubles the buffer size internally when
  86                                                  changing it to cater for additional space needed by
  87                                                  the linux kernel. This call will therefore return
  88                                                  only half the value reported by the kernel. */
  89         void sndbuf(unsigned size) const; ///< Change size of send buffer
  90                                         /**< \param[in] size new send buffer size */
  91
  92      };
  93
  94     /** \brief Protocol facet providing basic connection oriented BSD socket functions
  95
  96         AddressableBSDSocketProtocol provides the BSD socket API as it generically applies to
  97         addressable (connection oriented) sockets.
  98      */
  99     class AddressableBSDSocketProtocol
 100         : public virtual SocketProtocol
 101     {
 102     public:
 103         bool reuseaddr() const;         ///< Return current reuseaddr state
 104                                         /**< \returns \c true if \c SO_REUSEADDR is currently
 105                                              enabled, \c false otherwise*/
 106         void reuseaddr(bool value) const; ///< Set reuseraddr state
 107                                         /**< A \c true value enables \c SO_REUSEADDR, \c false will
 108                                              disable it.
 109                                              \param[in] value new \c SO_REUSEADDR state */
 110     };
 111
 112     /// @}
 113
 114 }
 115
 116
 117 ///////////////////////////////hh.e////////////////////////////////////////
 118 //#include "BSDSocketProtocol.cci"
 119 //#include "BSDSocketProtocol.ct"
 120 //#include "BSDSocketProtocol.cti"
 121 //#include "BSDSocketProtocol.mpp"
 122 #endif
 123
 124 \f
 125 // Local Variables:
 126 // mode: c++
 127 // fill-column: 100
 128 // c-file-style: "senf"
 129 // indent-tabs-mode: nil
 130 // ispell-local-dictionary: "american"
 131 // compile-command: "scons -u test"
 132 // comment-column: 40
 133 // End: