MACAddress.hh

Go to the documentation of this file.

//
// Copyright (c) 2020 Fraunhofer Institute for Applied Information Technology (FIT)
//                    Network Research Group (NET)
//                    Schloss Birlinghoven, 53754 Sankt Augustin, GERMANY
//                    Contact: support@wiback.org
//
// This file is part of the SENF code tree.
// It is licensed under the 3-clause BSD License (aka New BSD License).
// See LICENSE.txt in the top level directory for details or visit
// https://opensource.org/licenses/BSD-3-Clause
//


#ifndef HH_SENF_Socket_Protocols_Raw_MACAddress_
#define HH_SENF_Socket_Protocols_Raw_MACAddress_ 1

// Custom includes
#include <iosfwd>
#include <cstdint>
#include <boost/array.hpp>
#include <functional>
#include <senf/Utils/Tags.hh>
#include <senf/autoconf.hh>

//#include "MACAddress.mpp"
//-/////////////////////////////////////////////////////////////////////////////////////////////////

namespace senf {

    struct EUI64;

    struct MACAddress
        : public boost::array<std::uint8_t,6>
    {
        static MACAddress const Broadcast; 
        static MACAddress const None;   

        // make sure we are compatible with older code expecting boost::array 
        // static constexpr unsigned static_size = 6;
        
        MACAddress();                   
        MACAddress(senf::NoInit_t);     
        explicit MACAddress(std::uint64_t const & v); 

        static MACAddress from_string(std::string const & s);

        template <class InputIterator>
        static MACAddress from_data(InputIterator i);

        static MACAddress from_eui64(senf::EUI64 const & eui);

        explicit operator bool() const;  
        bool operator<(MACAddress const & other) const;
        bool operator==(EUI64 const & eui64) const;

        bool local() const;              
        bool multicast() const;          
        bool broadcast() const;          

        void local(bool flag);
        void multicast(bool flag);

        std::uint32_t oui() const;    
        std::uint32_t nic() const;    

        void oui(std::uint32_t oui);  
        void nic(std::uint32_t oui);  
        
        std::uint64_t eui64() const;  
        std::uint64_t uint64() const; 

        std::uint32_t const & hash32() const;
        void hash(std::uint64_t * hash, std::uint16_t const & otherKey = 0) const; 
    };

    std::ostream & operator<<(std::ostream & os, MACAddress const & mac);

    std::istream & operator>>(std::istream & is, MACAddress & mac);

    bool operator==(EUI64 const & eui64, MACAddress const & mac);

# if __SIZEOF_SIZE_T__ == 8
    std::size_t hash_value(MACAddress const & mac) noexcept;
#elif __SIZEOF_SIZE_T__ == 4
    std::size_t const & hash_value(MACAddress const & mac) noexcept;
#else
    std::size_t hash_value(MACAddress const & mac) noexcept;    
#endif
}

#ifdef SENF_CXX11_ENABLED
namespace std {
    template <> struct hash<senf::MACAddress>
    {
# if __SIZEOF_SIZE_T__ == 8
        std::size_t operator()(senf::MACAddress const & mac) const noexcept {
            return senf::hash_value(mac);
        }
#elif  __SIZEOF_SIZE_T__ == 4
        std::size_t const & operator()(senf::MACAddress const & mac) const noexcept {
            return mac.hash32();
        }
#endif
    };
}
#endif

//-/////////////////////////////////////////////////////////////////////////////////////////////////
#include "MACAddress.cci"
#include "MACAddress.ct"
//#include "MACAddress.cti"
#endif


// Local Variables:
// mode: c++
// fill-column: 100
// comment-column: 40
// c-file-style: "senf"
// indent-tabs-mode: nil
// ispell-local-dictionary: "american"
// compile-command: "scons -u test"
// End: