senf/Socket/Protocols/UN/UNSocketProtocol.hh

   1 // $Id$
   2 //
   3 // Copyright (C) 2007
   4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
   5 //
   6 // The contents of this file are subject to the Fraunhofer FOKUS Public License
   7 // Version 1.0 (the "License"); you may not use this file except in compliance
   8 // with the License. You may obtain a copy of the License at
   9 // http://senf.berlios.de/license.html
  10 //
  11 // The Fraunhofer FOKUS Public License Version 1.0 is based on,
  12 // but modifies the Mozilla Public License Version 1.1.
  13 // See the full license text for the amendments.
  14 //
  15 // Software distributed under the License is distributed on an "AS IS" basis,
  16 // WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  17 // for the specific language governing rights and limitations under the License.
  18 //
  19 // The Original Code is Fraunhofer FOKUS code.
  20 //
  21 // The Initial Developer of the Original Code is Fraunhofer-Gesellschaft e.V.
  22 // (registered association), Hansastraße 27 c, 80686 Munich, Germany.
  23 // All Rights Reserved.
  24 //
  25 // Contributor(s):
  26 //   David Wagner <dw6@berlios.de>
  27 /** \file
  28     \brief UNSocketProtocol public header */
  29
  30 #ifndef HH_SENF_Socket_Protocols_UN_UNSocketProtocol_
  31 #define HH_SENF_Socket_Protocols_UN_UNSocketProtocol_ 1
  32
  33 // Custom includes
  34 #include <senf/Socket/SocketProtocol.hh>
  35
  36 //#include "UNSocketProtocol.mpp"
  37 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  38
  39 namespace senf {
  40
  41     /// \addtogroup protocol_facets_group
  42     //\{
  43
  44     /** \brief Protocol facet providing Unix Domain Addressing related API
  45
  46         This protocol facet introduces all the socket api protocol members which are related to Unix
  47         Domain addressing.
  48      */
  49     class UNSocketProtocol
  50         : public virtual SocketProtocol
  51     {
  52     public:
  53         virtual void close();           ///< Close socket
  54                                         /**< This override will automatically \c shutdown() the
  55                                              socket whenever it is closed.
  56                                              \throws senf::SystemException */ //
  57         virtual void terminate() const;       ///< Forcibly close socket
  58                                         /**< This override will automatically \c shutdown() the
  59                                            socket whenever it is called. Additionally it will
  60                                            disable SO_LINGER to ensure, that v_terminate will not
  61                                            block. Like the overridden method, this member will
  62                                            ignore failures and will never throw. It therefore
  63                                            safe to be called from a destructor. */
  64
  65         ///\name Abstract Interface Implementation
  66         //\{
  67
  68         unsigned available() const;
  69         bool eof() const;
  70
  71         //\}
  72
  73     private:
  74         void check_and_unlink() const;
  75
  76         std::string path_;
  77     };
  78
  79 }
  80
  81 //-/////////////////////////////////////////////////////////////////////////////////////////////////
  82 //#include "UNSocketProtocol.cci"
  83 //#include "UNSocketProtocol.ct"
  84 //#include "UNSocketProtocol.cti"
  85 #endif
  86
  87 \f
  88 // Local Variables:
  89 // mode: c++
  90 // fill-column: 100
  91 // comment-column: 40
  92 // c-file-style: "senf"
  93 // indent-tabs-mode: nil
  94 // ispell-local-dictionary: "american"
  95 // compile-command: "scons -u test"
  96 // End: