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 "../../../Socket/SocketPolicy.hh"
  35 #include "../../../Socket/ClientSocketHandle.hh"
  36 #include "../../../Socket/CommunicationPolicy.hh"
  37 #include "../../../Socket/Protocols/GenericAddressingPolicy.hh"
  38 #include "../../../Utils/safe_bool.hh"
  39 #include "UNAddress.hh"
  40
  41 //#include "UNAddressing.mpp"
  42 ///////////////////////////////hh.p////////////////////////////////////////
  43 namespace senf {
  44     /** \brief Unix domain socket address
  45
  46         UNSocketAddress wraps the standard sockaddr_un datatype. It provides simple accessor methods
  47         to access the path.
  48
  49         \implementation This implementation is based on sockaddr_un.
  50
  51         \ingroup addr_group
  52      */
  53     class UNSocketAddress
  54         : public comparable_safe_bool<UNSocketAddress>
  55     {
  56     public:
  57
  58         //UNSocketAddress();
  59         explicit UNSocketAddress(std::string p);
  60                                         ///< Construct an address constant from given path
  61         static UNSocketAddress from_string(std::string const s); ///< Create UNSocketAddress from string
  62         std::string path() const ;  ///< Return path as string
  63         struct sockaddr_un sockaddr();
  64         struct sockaddr * sockaddr_p() ;
  65         struct sockaddr const * sockaddr_p() const;
  66         unsigned sockaddr_len() const;
  67     private:
  68         struct sockaddr_un sockAddr;
  69     };
  70
  71     /** \brief Write path  os
  72
  73         \related UNSocketAddress
  74      */
  75     std::ostream & operator<<(std::ostream & os, UNSocketAddress const & addr);
  76
  77     /// \addtogroup policy_impl_group
  78     /// @{
  79
  80     /** \brief Addressing policy supporting unix domain addressing
  81
  82         \par Address Type:
  83             UNAddress
  84
  85         This addressing policy implements addressing using unix domain
  86         addresses.
  87
  88         The various members are directly imported from
  89         GenericAddressingPolicy which see for a detailed
  90         documentation.
  91      */
  92     struct UNAddressingPolicy
  93         : public AddressingPolicyBase,
  94           private GenericAddressingPolicy<UNSocketAddress>
  95     {
  96         typedef UNSocketAddress Address;
  97
  98         using GenericAddressingPolicy<UNSocketAddress>::peer;
  99         using GenericAddressingPolicy<UNSocketAddress>::local;
 100         using GenericAddressingPolicy<UNSocketAddress>::connect;
 101         using GenericAddressingPolicy<UNSocketAddress>::bind;
 102     };
 103 }
 104 ///////////////////////////////hh.e////////////////////////////////////////
 105 //#include "UNAddressing.cci"
 106 //#include "UNAddressing.ct"
 107 //#include "UNAddressing.cti"
 108 #endif
 109
 110 \f
 111 // Local Variables:
 112 // mode: c++
 113 // fill-column: 100
 114 // comment-column: 40
 115 // c-file-style: "senf"
 116 // indent-tabs-mode: nil
 117 // ispell-local-dictionary: "american"
 118 // compile-command: "scons -u test"
 119 // End: