/** \file
\brief MACAddress public header */
-#ifndef HH_MACAddress_
-#define HH_MACAddress_ 1
+#ifndef HH_SENF_Socket_Protocols_Raw_MACAddress_
+#define HH_SENF_Socket_Protocols_Raw_MACAddress_ 1
// Custom includes
#include <iostream>
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
// 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
\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
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.
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
+ 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);
}
//#include "MACAddress.cti"
#endif
-\f
+
// Local Variables:
// mode: c++
// fill-column: 100