Socket/Protocols/UN/UNAddressing.hh

   1 // Copyright (C) 2007
   2 // Fraunhofer Institut fuer offene Kommunikationssysteme (FOKUS)
   3 // Kompetenzzentrum NETwork research (NET)
   4 //     David Wagner <david.wagner@fokus.fraunhofer.de>
   5 //
   6 // This program is free software; you can redistribute it and/or modify
   7 // it under the terms of the GNU General Public License as published by
   8 // the Free Software Foundation; either version 2 of the License, or
   9 // (at your option) any later version.
  10 //
  11 // This program is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU General Public License
  17 // along with this program; if not, write to the
  18 // Free Software Foundation, Inc.,
  19 // 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20
  21 /** \file
  22     \brief UNAddressing public header */
  23
  24 #ifndef HH_UNAddressing_
  25 #define HH_UNAddressing_ 1
  26
  27 // Custom includes
  28 #include <iostream>
  29 #include <string>
  30 #include <sys/socket.h>
  31 #include <sys/un.h>
  32 #include <boost/cstdint.hpp>
  33 #include <boost/operators.hpp>
  34 #include "boost/filesystem/path.hpp"
  35 #include "../../../Socket/SocketPolicy.hh"
  36 #include "../../../Socket/ClientSocketHandle.hh"
  37 #include "../../../Socket/CommunicationPolicy.hh"
  38 #include "../../../Socket/Protocols/GenericAddressingPolicy.hh"
  39 #include "../../../Utils/safe_bool.hh"
  40 #include "UNAddress.hh"
  41
  42 //#include "UNAddressing.mpp"
  43 ///////////////////////////////hh.p////////////////////////////////////////
  44 namespace senf {
  45     /** \brief Unix domain socket address
  46
  47         UNSocketAddress wraps the standard sockaddr_un datatype. It provides simple accessor methods
  48         to access the path.
  49
  50         \implementation This implementation is based on sockaddr_un.
  51
  52         \ingroup addr_group
  53      */
  54     class UNSocketAddress
  55         : public comparable_safe_bool<UNSocketAddress>
  56     {
  57     public:
  58
  59         //UNSocketAddress();
  60         explicit UNSocketAddress(boost::filesystem::path p);
  61                                         ///< Construct an address constant from given path
  62         static UNSocketAddress from_string(std::string const s); ///< Create UNSocketAddress from string
  63         static UNSocketAddress from_path(boost::filesystem::path const p); ///< Create UNSocketAddress from path
  64         std::string path() const ;  ///< Return path as string
  65         struct sockaddr_un sockaddr();
  66         struct sockaddr * sockaddr_p() ;
  67         struct sockaddr const * sockaddr_p() const;
  68         unsigned sockaddr_len();
  69     private:
  70         struct sockaddr_un sockAddr;
  71     };
  72
  73     /** \brief Write path  os
  74
  75         \related UNSocketAddress
  76      */
  77     std::ostream & operator<<(std::ostream & os, UNSocketAddress const & addr);
  78
  79     /// \addtogroup policy_impl_group
  80     /// @{
  81
  82     /** \brief Addressing policy supporting unix domain addressing
  83
  84         \par Address Type:
  85             UNAddress
  86
  87         This addressing policy implements addressing using unix domain
  88         addresses.
  89
  90         The various members are directly imported from
  91         GenericAddressingPolicy which see for a detailed
  92         documentation.
  93      */
  94
  95     struct UNAddressingPolicy
  96         : public AddressingPolicyBase,
  97           private GenericAddressingPolicy<UNSocketAddress>
  98     {
  99         typedef UNSocketAddress Address;
 100
 101         using GenericAddressingPolicy<UNSocketAddress>::peer;
 102         using GenericAddressingPolicy<UNSocketAddress>::local;
 103         using GenericAddressingPolicy<UNSocketAddress>::connect;
 104         using GenericAddressingPolicy<UNSocketAddress>::bind;
 105     };
 106 }
 107 ///////////////////////////////hh.e////////////////////////////////////////
 108 //#include "UNAddressing.cci"
 109 //#include "UNAddressing.ct"
 110 //#include "UNAddressing.cti"
 111 #endif
 112
 113 \f
 114 // Local Variables:
 115 // mode: c++
 116 // fill-column: 100
 117 // comment-column: 40
 118 // c-file-style: "senf"
 119 // indent-tabs-mode: nil
 120 // ispell-local-dictionary: "american"
 121 // compile-command: "scons -u test"
 122 // End: