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 "../../../Socket/SocketProtocol.hh"
  31 #include "UNAddressing.hh"
  32 #include "../../../Socket/ClientSocketHandle.hh"
  33 #include "../../../Socket/CommunicationPolicy.hh"
  34
  35 //#include "UNSocketProtocol.mpp"
  36 ///////////////////////////////hh.p////////////////////////////////////////
  37
  38 namespace senf {
  39
  40     /// \addtogroup protocol_facets_group
  41     /// @{
  42
  43     /** \brief Protocol facet providing Unix Domain Addressing related API
  44
  45         This protocol facet introduces all the socket api protocol members which are related to Unix
  46         Domain addressing.
  47      */
  48     class UNSocketProtocol
  49         : public virtual SocketProtocol
  50     {
  51     public:
  52         virtual void close();           ///< Close socket
  53                                         /**< This override will automatically \c shutdown() the
  54                                              socket whenever it is closed.
  55                                              \throws senf::SystemException */ //
  56         virtual void terminate() const;       ///< Forcibly close socket
  57                                         /**< This override will automatically \c shutdown() the
  58                                            socket whenever it is called. Additionally it will
  59                                            disable SO_LINGER to ensure, that v_terminate will not
  60                                            block. Like the overriden method, this member will ignore
  61                                            failures and will never throw. It therefore safe to be
  62                                            called from a destructor. */        ///\name Abstract Interface Implementation
  63         ///@{
  64
  65          unsigned available() const;
  66          bool eof() const;
  67
  68     private:
  69         void check_and_unlink() const;
  70
  71         std::string path_;
  72     };
  73
  74     ///@}
  75 }
  76
  77 ///////////////////////////////hh.e////////////////////////////////////////
  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: