senf/Socket/Protocols/UN/UNSocketProtocol.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
   6 //     David Wagner <dw6@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 UNSocketProtocol public header */
  25
  26 #ifndef HH_SENF_Socket_Protocols_UN_UNSocketProtocol_
  27 #define HH_SENF_Socket_Protocols_UN_UNSocketProtocol_ 1
  28
  29 // Custom includes
  30 #include <senf/Socket/SocketProtocol.hh>
  31
  32 //#include "UNSocketProtocol.mpp"
  33 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  34
  35 namespace senf {
  36
  37     /// \addtogroup protocol_facets_group
  38     //\{
  39
  40     /** \brief Protocol facet providing Unix Domain Addressing related API
  41
  42         This protocol facet introduces all the socket api protocol members which are related to Unix
  43         Domain addressing.
  44      */
  45     class UNSocketProtocol
  46         : public virtual SocketProtocol
  47     {
  48     public:
  49         virtual void close();           ///< Close socket
  50                                         /**< This override will automatically \c shutdown() the
  51                                              socket whenever it is closed.
  52                                              \throws senf::SystemException */ //
  53         virtual void terminate() const;       ///< Forcibly close socket
  54                                         /**< This override will automatically \c shutdown() the
  55                                            socket whenever it is called. Additionally it will
  56                                            disable SO_LINGER to ensure, that v_terminate will not
  57                                            block. Like the overridden method, this member will
  58                                            ignore failures and will never throw. It therefore
  59                                            safe to be called from a destructor. */
  60
  61         ///\name Abstract Interface Implementation
  62         //\{
  63
  64         unsigned available() const;
  65         bool eof() const;
  66
  67         //\}
  68
  69     private:
  70         void check_and_unlink() const;
  71
  72         std::string path_;
  73     };
  74
  75 }
  76
  77 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  78 //#include "UNSocketProtocol.cci"
  79 //#include "UNSocketProtocol.ct"
  80 //#include "UNSocketProtocol.cti"
  81 #endif
  82
  83 \f
  84 // Local Variables:
  85 // mode: c++
  86 // fill-column: 100
  87 // comment-column: 40
  88 // c-file-style: "senf"
  89 // indent-tabs-mode: nil
  90 // ispell-local-dictionary: "american"
  91 // compile-command: "scons -u test"
  92 // End: