mac_address.hpp

Go to the documentation of this file.

 
#ifndef JOIN_CORE_MAC_ADDRESS_HPP
#define JOIN_CORE_MAC_ADDRESS_HPP
 
// libjoin.
#include <join/ip_address.hpp>
 
// C++
#include <ostream>
#include <compare>
#include <string>
#include <array>
 
// C
#include <unistd.h>
#include <net/if.h>
 
namespace join
{
    class MacAddress
    {
    public:
        using CaseConvert = std::ios_base&(std::ios_base&);
 
        using iterator = std::array<uint8_t, IFHWADDRLEN>::iterator;
 
        using const_iterator = std::array<uint8_t, IFHWADDRLEN>::const_iterator;
 
        MacAddress ();
 
        MacAddress (const MacAddress& address);
 
        MacAddress (MacAddress&& address);
 
        MacAddress (const uint8_t* address, size_t size);
 
        MacAddress (const uint8_t (&address)[IFHWADDRLEN]);
 
        MacAddress (std::initializer_list<uint8_t> address);
 
        MacAddress (const struct sockaddr& address);
 
        MacAddress (const char* address);
 
        MacAddress (const std::string& address);
 
        ~MacAddress () = default;
 
        int family () const;
 
        const uint8_t* addr () const;
 
        socklen_t length () const;
 
        bool isWildcard () const;
 
        bool isBroadcast () const;
 
        static bool isMacAddress (const std::string& address);
 
        std::string toString (CaseConvert caseConvert = std::nouppercase) const;
 
        IpAddress toIpv6 (const IpAddress& prefix, int len) const;
 
        IpAddress toLinkLocalIpv6 () const;
 
        IpAddress toUniqueLocalIpv6 () const;
 
        void clear ();
 
        iterator begin ();
 
        const_iterator begin () const;
 
        const_iterator cbegin () const;
 
        iterator end ();
 
        const_iterator end () const;
 
        const_iterator cend () const;
 
        static MacAddress address (const std::string& interface);
 
        MacAddress& operator= (const MacAddress& address);
 
        MacAddress& operator= (MacAddress&& address);
 
        MacAddress& operator= (std::initializer_list<uint8_t> address);
 
        MacAddress& operator= (const struct sockaddr& address);
 
        MacAddress& operator+= (int value);
 
        MacAddress& operator++ ();
 
        MacAddress operator++ (int);
 
        uint8_t& operator[] (size_t position);
 
        const uint8_t& operator[] (size_t position) const;
 
        MacAddress operator~() const;
 
        static const MacAddress wildcard;
 
        static const MacAddress broadcast;
 
    private:
        std::array<uint8_t, IFHWADDRLEN> _mac = {};
    };
 
    MacAddress operator+ (int value, const MacAddress& a);
 
    MacAddress operator+ (const MacAddress& a, int value);
 
    bool operator== (const MacAddress& a, const MacAddress& b);
 
    std::strong_ordering operator<=> (const MacAddress& a, const MacAddress& b);
 
    MacAddress operator& (const MacAddress& a, const MacAddress& b);
 
    MacAddress operator| (const MacAddress& a, const MacAddress& b);
 
    MacAddress operator^ (const MacAddress& a, const MacAddress& b);
 
    std::ostream& operator<< (std::ostream& out, const MacAddress& a);
}
 
#endif