Update valgrind suppressions

[senf.git] / Socket / Protocols / Raw / MACAddress.hh

diff --git a/Socket/Protocols/Raw/MACAddress.hh b/Socket/Protocols/Raw/MACAddress.hh
index 4281efd..64049dd 100644 (file)
--- a/Socket/Protocols/Raw/MACAddress.hh
+++ b/Socket/Protocols/Raw/MACAddress.hh
@@ -42,13 +42,13 @@
 namespace senf {
 
     /** \brief Ethernet MAC address
-        
+
         The Ethernet MAC is modelled as a fixed-size container/sequence of 6 bytes.
 
         The following statements all create the same MAC address <code>00:1A:2B:3C:4D:5F</code>
         \code
         // Used to construct constant MAC addresses
-        MACAddress(0x001A2B3C4D5Flu)
+        MACAddress(0x001A2B3C4D5Full)
 
         // Construct a MAC address from it's string representation:
         MACAddress::from_string("00:1a:2b:3c:4d:5f")   // case is ignored
@@ -62,19 +62,12 @@ namespace senf {
 
         // Construct a MAC from the EUID64 as used by INet6 interfaces.  The eui64 will come from an
         // INet6 address:
-        MACAddress::from_eui64(0x001A2BFFFE3C4D5Ful)
+        MACAddress::from_eui64(0x001A2BFFFE3C4D5Full)
         MACAddress::from_eui64(
             INet6Address(0x2001u,0xDB8u,0x1u,0x0u,0x001Au,0x2BFFu,0xFE3Cu,0x3D5Fu).id())
         \endcode
 
-        Since MACAddress is based on \c boo Ziel, aber nur ein paar davon sind standardkomform.
-
-Der aktuelle C++ Standard unterstützt drei verschiedene Möglichkeiten eine Zahl in einen String umzuwandeln. Diese Möglichkeiten sind:
-
-    * sprintf
-    * std::strstream
-    * std::stringstream
-        st::array, you can access the raw data bytes of the
+        Since MACAddress is based on \c boost::array, you can access the raw data bytes of the
         address using \c begin(), \c end() or \c operator[]:
         \code
         MACAddress mac = ...;
@@ -92,7 +85,7 @@ Der aktuelle C++ Standard unterstützt drei verschiedene Möglichkeiten eine Zah
         \ingroup addr_group
      */
     struct MACAddress
-        : public boost::array<boost::uint8_t,6>, 
+        : public boost::array<boost::uint8_t,6>,
           public comparable_safe_bool<MACAddress>
     {
         static MACAddress const Broadcast; ///< The broadcast address
@@ -110,7 +103,7 @@ Der aktuelle C++ Standard unterstützt drei verschiedene Möglichkeiten eine Zah
                                              accepted as a delimiter.
                                              \throws AddressSyntaxException */
 
-        template <class InputIterator> 
+        template <class InputIterator>
         static MACAddress from_data(InputIterator i);
                                         ///< Construct address from raw data
                                         /**< Copies the data from \a i into the MAC address.
@@ -133,17 +126,21 @@ Der aktuelle C++ Standard unterstützt drei verschiedene Möglichkeiten eine Zah
 
         boost::uint32_t oui() const;    ///< Return first 3 bytes of the address
         boost::uint32_t nic() const;    ///< Return last 3 bytes of the address
-        
-        boost::uint64_t eui64() const;  ///< Build EUI-64 from the MAC address
-        
-        std::string toString() const; ///< Return string representation of MAC address like 12:34:56:78:90:ab
 
+        boost::uint64_t eui64() const;  ///< Build EUI-64 from the MAC address
+        boost::uint64_t uint64() const; ///< Return MAC address as uint64 value
     };
 
-    /** \brief Write MAC address
+    /** \brief Output MAC instance as it's string representation
         \related MACAddress
      */
     std::ostream & operator<<(std::ostream & os, MACAddress const & mac);
+    /** \brief Try to initialize MACAddress instance from a string representation
+        sets std::ios::failbit on the stream if an error occurred
+        \see MACAddress from_string()
+        \related MACAddress
+     */
+    std::istream & operator>>(std::istream & os, MACAddress & mac);
 
 }
 
@@ -153,7 +150,7 @@ Der aktuelle C++ Standard unterstützt drei verschiedene Möglichkeiten eine Zah
 //#include "MACAddress.cti"
 #endif
 
-\f
+
 // Local Variables:
 // mode: c++
 // fill-column: 100