senf/Socket/Protocols/INet/TCPSocketProtocol.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 TCPSocketProtocol public header
  25  */
  26
  27 #ifndef HH_SENF_Socket_Protocols_INet_TCPSocketProtocol_
  28 #define HH_SENF_Socket_Protocols_INet_TCPSocketProtocol_ 1
  29
  30 // Custom includes
  31 #include "INetSocketProtocol.hh"
  32
  33 //#include "TCPSocketProtocol.mpp"
  34 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  35
  36 namespace senf {
  37
  38     /// \addtogroup protocol_facets_group
  39     //\{
  40
  41     /** \brief Protocol facet to support TCP operations
  42
  43         This protocol facet provides all those protocol functions,
  44         which are available on any TCP socket.
  45      */
  46     class TCPSocketProtocol
  47         : public virtual INetSocketProtocol
  48     {
  49     public:
  50         bool nodelay() const;           ///< Check current \c SO_NODELAY status
  51         void nodelay(bool value) const; ///< Set \c SO_NODELAY status
  52                                         /**< Enabling \c SO_NODELAY will disable the NAGLE
  53                                              algorithm (which aggregates multiple writes into a
  54                                              single network packet). Enabling nodelay() optimizes
  55                                              the response time at the expense of the bandwidth
  56                                              efficiency.
  57                                              \param[in] value \c SO_NODELAY state */
  58
  59         unsigned siocinq() const;       ///< Return current size of the input queue
  60         unsigned siocoutq() const;      ///< Return current size of the output queue
  61
  62         enum ShutType { ShutRD, ShutWR, ShutRDWR };
  63         void shutdown(ShutType type) const;
  64
  65         ///\name Abstract Interface Implementation
  66         //\{
  67
  68         void close();
  69         unsigned available() const;
  70         bool eof() const;
  71
  72         //\}
  73     };
  74
  75     //\}
  76 }
  77
  78 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  79 //#include "TCPSocketProtocol.cci"
  80 //#include "TCPSocketProtocol.ct"
  81 //#include "TCPSocketProtocol.cti"
  82 #endif
  83
  84 \f
  85 // Local Variables:
  86 // mode: c++
  87 // fill-column: 100
  88 // c-file-style: "senf"
  89 // indent-tabs-mode: nil
  90 // ispell-local-dictionary: "american"
  91 // compile-command: "scons -u test"
  92 // comment-column: 40
  93 // End: