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