MACAddress.h

Go to the documentation of this file.

/*
 * Copyright (C) 2003 Andras Varga; CTIE, Monash University, Australia
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
*/

#ifndef MACADDRESS_H_
#define MACADDRESS_H_

#include <string>
#include <omnetpp.h>
#include "INETDefs.h"


#define MAC_ADDRESS_BYTES 6

class InterfaceToken;


class INET_API MACAddress
{
  private:
    unsigned char address[6];   // 6*8=48 bit address
    static unsigned int autoAddressCtr; // global counter for generateAutoAddress()

  public:
    static const MACAddress UNSPECIFIED_ADDRESS;

    static const MACAddress BROADCAST_ADDRESS;

    MACAddress();

    MACAddress(const char *hexstr);

    MACAddress(const MACAddress& other) {operator=(other);}

    MACAddress& operator=(const MACAddress& other);

    unsigned int getAddressSize() const;

    unsigned char getAddressByte(unsigned int k) const;

    void setAddressByte(unsigned int k, unsigned char addrbyte);

    bool tryParse(const char *hexstr);

    void setAddress(const char *hexstr);

    unsigned char *getAddressBytes() {return address;}

    void setAddressBytes(unsigned char *addrbytes);

    void setBroadcast();

    bool isBroadcast() const;

    bool isMulticast() const  {return address[0]&0x80;};

    bool isUnspecified() const;

    std::string str() const;

    bool equals(const MACAddress& other) const;

    bool operator==(const MACAddress& other) const {return (*this).equals(other);}

    bool operator!=(const MACAddress& other) const {return !(*this).equals(other);}

    int compareTo(const MACAddress& other) const;

    InterfaceToken formInterfaceIdentifier() const;

    static MACAddress generateAutoAddress();

};

inline std::ostream& operator<<(std::ostream& os, const MACAddress& mac)
{
    return os << mac.str();
}

#endif