4 // Fraunhofer Institute for Open Communication Systems (FOKUS)
5 // Competence Center NETwork research (NET), St. Augustin, GERMANY
6 // Stefan Bund <g0dil@berlios.de>
8 // This program is free software; you can redistribute it and/or modify
9 // it under the terms of the GNU General Public License as published by
10 // the Free Software Foundation; either version 2 of the License, or
11 // (at your option) any later version.
13 // This program is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // You should have received a copy of the GNU General Public License
19 // along with this program; if not, write to the
20 // Free Software Foundation, Inc.,
21 // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 \brief MACAddress public header */
26 #ifndef HH_MACAddress_
27 #define HH_MACAddress_ 1
31 #include <boost/cstdint.hpp>
32 #include <boost/array.hpp>
33 #include <boost/utility.hpp>
34 #include <boost/type_traits.hpp>
35 #include "../../../Utils/safe_bool.hh"
36 #include "../../../Utils/Tags.hh"
38 //#include "MACAddress.mpp"
39 ///////////////////////////////hh.p////////////////////////////////////////
43 /** \brief Ethernet MAC address
45 The Ethernet MAC is modelled as a fixed-size container/sequence of 6 bytes.
47 \implementation We awkwardly need to use static named constructors (<tt>from_</tt> members)
48 instead of ordinarily overloaded constructors for one simple reason: <tt>char *</tt>
49 doubles as string literal and as arbitrary data iterator. The iterator constructor can
50 therefore not be distinguished from initialization with a string literal. Therefore we
51 need to disambiguate using the named constructors.
56 : public boost::array<boost::uint8_t,6>,
57 public comparable_safe_bool<MACAddress>
59 static MACAddress const Broadcast; ///< The broadcast address
60 static MACAddress const None; ///< The empty (0) address
62 MACAddress(); ///< Construct zero-initialized address
63 MACAddress(senf::NoInit_t); ///< Construct uninitialized (!) address
64 explicit MACAddress(boost::uint64_t v); ///< Construct MACAddress constants
66 static MACAddress from_string(std::string const & s);
67 ///< Construct address from string representation
68 /**< The string representation must exactly match the form
69 <tt>dd:dd:dd:dd:dd:dd</tt> where <tt>d</tt> is any
70 hexadecimal digit. In place of ':', '-' is also
71 accepted as a delimiter. */
73 template <class InputIterator>
74 static MACAddress from_data(InputIterator i);
75 ///< Construct address from raw data
76 /**< Copies the data from \a i into the MAC address.
77 \pre The input range at \a i must have a size of at
80 static MACAddress from_eui64(boost::uint64_t v);
81 ///< Construct address from EUI-64
82 /**< This constructor takes an EUI-64 value and converts it
83 to a MAC address. This conversion is only possible, if
84 the EUI-64 is MAC compatible: the 4th/5th byte (in
85 transmission order) must be 0xFFFE.
86 \throws SyntaxException if \a v is not a MAC compatible
89 bool local() const; ///< \c true, if address is locally administered
90 bool multicast() const; ///< \c true, if address is a group/multicast address
91 bool broadcast() const; ///< \c true, if address is the broadcast address
92 bool boolean_test() const; ///< \c true, if address is the zero address
94 boost::uint32_t oui() const; ///< Return first 3 bytes of the address
95 boost::uint32_t nic() const; ///< Return last 3 bytes of the address
97 boost::uint64_t eui64() const; ///< Build EUI-64 from the MAC address
99 /** \brief Bad MAC address syntax or conversion */
100 struct SyntaxException : public std::exception
101 { virtual char const * what() const throw() { return "invalid MAC address syntax"; } };
104 /** \brief Write MAC address
107 std::ostream & operator<<(std::ostream & os, MACAddress const & mac);
111 ///////////////////////////////hh.e////////////////////////////////////////
112 #include "MACAddress.cci"
113 #include "MACAddress.ct"
114 //#include "MACAddress.cti"
121 // comment-column: 40
122 // c-file-style: "senf"
123 // indent-tabs-mode: nil
124 // ispell-local-dictionary: "american"
125 // compile-command: "scons -u test"