MacAddress.h

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------

   http://www.hyperrealm.com/oss_commoncpp.shtml
*/

#pragma once

#include "WString.h"
#include "Print.h"
#include <cstdint>

class MacAddress : public Printable
{
    // https://www.artima.com/cppsource/safebool.html
    typedef void (MacAddress::*bool_type)() const;
    void Testable() const
    {
    }

public:
    typedef uint8_t Octets[6];

    MacAddress() = default;

    MacAddress(const Octets& octets)
    {
        setOctets(octets);
    }

    void getOctets(Octets& octets) const
    {
        memcpy(octets, this->octets, 6);
    }

    void setOctets(const Octets& octets)
    {
        memcpy(this->octets, octets, 6);
    }

    uint8_t operator[](unsigned index) const;

    uint8_t& operator[](unsigned index);

    String toString(char sep = ':') const;

    bool operator==(const MacAddress& other) const
    {
        return memcmp(octets, other.octets, sizeof(octets)) == 0;
    }

    inline bool operator!=(const MacAddress& other) const
    {
        return !operator==(other);
    }

    bool operator!() const;

    operator bool_type() const
    {
        return operator!() ? nullptr : &MacAddress::Testable;
    }

    void clear()
    {
        memset(octets, 0, sizeof(octets));
    }

    uint32_t getHash() const;

    size_t printTo(Print& p) const override
    {
        return p.print(toString());
    }

private:
    Octets octets = {0};
};

#define MACADDR_NONE MacAddress()