removed some useless spaces; not very important, I know :)

[senf.git] / Socket / Protocols / UN / UNAddressing.hh

diff --git a/Socket/Protocols/UN/UNAddressing.hh b/Socket/Protocols/UN/UNAddressing.hh
index 4529e91..fc918a3 100644 (file)
--- a/Socket/Protocols/UN/UNAddressing.hh
+++ b/Socket/Protocols/UN/UNAddressing.hh
@@ -1,6 +1,9 @@
 // $Id$
 //
-// Copyright (C) 2007 
+// Copyright (C) 2007
+// Fraunhofer Institute for Open Communication Systems (FOKUS)
+// Competence Center NETwork research (NET), St. Augustin, GERMANY
+//     David Wagner <dw6@berlios.de>
 //
 // This program is free software; you can redistribute it and/or modify
 // it under the terms of the GNU General Public License as published by
@@ -30,37 +33,76 @@
 #include <sys/un.h>
 #include <boost/cstdint.hpp>
 #include <boost/operators.hpp>
-#include "boost/filesystem/path.hpp"
 #include "../../../Socket/SocketPolicy.hh"
 #include "../../../Socket/ClientSocketHandle.hh"
 #include "../../../Socket/CommunicationPolicy.hh"
 #include "../../../Socket/Protocols/GenericAddressingPolicy.hh"
-#include "UNAddress.hh"
+#include "../../../Utils/safe_bool.hh"
 
 //#include "UNAddressing.mpp"
 ///////////////////////////////hh.p////////////////////////////////////////
+
 namespace senf {
+
+    /** \brief Unix domain socket address
+
+        UNSocketAddress wraps the standard sockaddr_un datatype. It provides simple accessor methods
+        to access the path. 
+        
+        \implementation This implementation is based on sockaddr_un.
+
+        \ingroup addr_group
+
+        \fixme Why both std::string constructor and from_string member ?
+     */
     class UNSocketAddress
-        : public ComparableSafeBool<UNSocketAddress>
+        : public comparable_safe_bool<UNSocketAddress>
     {
     public:
+        UNSocketAddress(); 
+        explicit UNSocketAddress(std::string p);
+                                        ///< Construct an address constant from given path
+        static UNSocketAddress from_string(std::string const s); 
+                                        ///< Create UNSocketAddress from string
+
+        bool operator==(UNSocketAddress const & other) const;
+                                        ///< Compare UNSocketAddress for equality
+
+        std::string path() const ;      ///< Return path as string
+
+        bool boolean_test() const;      ///< \c true, if address is not empty
+        
+        void clear();                   ///< Clear address
 
-        //UNSocketAddress();
-        explicit UNSocketAddress(boost::filesystem::path p);
-                                        ///< Construct an address constant
-        static UNSocketAddress from_string(std::string const s);
-        static UNSocketAddress from_path(boost::filesystem::path const p);
-        static std::string path();
-        static sockaddr_un sockaddr(); 
-        struct sockaddr * sockaddr_p();
+        struct sockaddr * sockaddr_p() ;
         struct sockaddr const * sockaddr_p() const;
         unsigned sockaddr_len() const;
+
     private:
-        static struct sockaddr_un sockAddr;
+        struct sockaddr_un addr_;
     };
+
+    /** \brief Write path to os
+
+        \related UNSocketAddress
+     */
     std::ostream & operator<<(std::ostream & os, UNSocketAddress const & addr);
 
+    /// \addtogroup policy_impl_group
+    /// @{
+
+    /** \brief Addressing policy supporting unix domain addressing
 
+        \par Address Type:
+            UNAddress
+
+        This addressing policy implements addressing using unix domain
+        addresses.
+
+        The various members are directly imported from
+        GenericAddressingPolicy which see for a detailed
+        documentation.
+     */
     struct UNAddressingPolicy
         : public AddressingPolicyBase,
           private GenericAddressingPolicy<UNSocketAddress>
@@ -72,7 +114,10 @@ namespace senf {
         using GenericAddressingPolicy<UNSocketAddress>::connect;
         using GenericAddressingPolicy<UNSocketAddress>::bind;
     };
+
+    ///@}
 }
+
 ///////////////////////////////hh.e////////////////////////////////////////
 //#include "UNAddressing.cci"
 //#include "UNAddressing.ct"