MACAddress Class Reference

#include <MACAddress.h>

List of all members.

---

Detailed Description

Stores an IEEE 802 MAC address (6 octets = 48 bits).

Public Member Functions
	MACAddress ()
	MACAddress (const char *hexstr)
	MACAddress (const MACAddress &other)
MACAddress &	operator= (const MACAddress &other)
unsigned int	getAddressArraySize () const
unsigned char	getAddress (unsigned int k) const
void	setAddress (unsigned int k, unsigned char addrbyte)
void	setAddress (const char *hexstr)
unsigned char *	getAddressBytes ()
void	setAddressBytes (unsigned char *addrbytes)
void	setBroadcast ()
bool	isBroadcast () const
bool	isMulticast () const
bool	isUnspecified () const
std::string	str () const
bool	equals (const MACAddress &other) const
bool	operator== (const MACAddress &other) const
int	compareTo (const MACAddress &other) const
InterfaceToken	formInterfaceIdentifier () const
Static Public Member Functions
static MACAddress	generateAutoAddress ()
Static Public Attributes
static const MACAddress	UNSPECIFIED_ADDRESS
static const MACAddress	BROADCAST_ADDRESS
Private Attributes
unsigned char	address [6]
Static Private Attributes
static unsigned int	autoAddressCtr

---

Constructor & Destructor Documentation

MACAddress::MACAddress (   )

Default constructor initializes address bytes to zero. { address[0]=address[1]=address[2]=address[3]=address[4]=address[5]=0; }

MACAddress::MACAddress (  const char *  hexstr  )

Constructor which accepts hex string or the string "auto". { setAddress(hexstr); }

MACAddress::MACAddress (  const MACAddress &  other  )  [inline]

Copy constructor. {operator=(other);}

---

Member Function Documentation

int MACAddress::compareTo (  const MACAddress &  other  )  const

Returns -1, 0 or 1 as result of comparison of 2 addresses. { return memcmp(address, other.address, MAC_ADDRESS_BYTES); }

bool MACAddress::equals (  const MACAddress &  other  )  const

Returns true if the two addresses are equal. { return memcmp(address, other.address, MAC_ADDRESS_BYTES)==0; }

InterfaceToken MACAddress::formInterfaceIdentifier (   )  const

Create interface identifier (IEEE EUI-64) which can be used by IPv6 stateless address autoconfiguration. { const unsigned char *b = address; uint32 high = (b[0]<<24) | (b[1]<<16) | (b[2]<<8) | 0xff; uint32 low = (0xfe<<24) | (b[3]<<16) | (b[4]<<8) | b[5]; return InterfaceToken(low, high, 64); }

MACAddress MACAddress::generateAutoAddress (   )  [static]

Generates a unique address which begins with 0a:aa and ends in a unique suffix. { ++autoAddressCtr; unsigned char addrbytes[6]; addrbytes[0] = 0x0A; addrbytes[1] = 0xAA; addrbytes[2] = (autoAddressCtr>>24)&0xff; addrbytes[3] = (autoAddressCtr>>16)&0xff; addrbytes[4] = (autoAddressCtr>>8)&0xff; addrbytes[5] = (autoAddressCtr)&0xff; MACAddress addr; addr.setAddressBytes(addrbytes); return addr; }

unsigned char MACAddress::getAddress (  unsigned int  k  )  const

Returns the kth byte of the address. { if (k>=6) throw new cException("Array of size 6 indexed with %d", k); return address[k]; }

unsigned int MACAddress::getAddressArraySize (   )  const

Returns 6. { return 6; }

unsigned char* MACAddress::getAddressBytes (   )  [inline]

Returns pointer to internal binary representation of address (array of 6 unsigned chars). {return address;}

bool MACAddress::isBroadcast (   )  const

Returns true this is the broadcast address (hex ff:ff:ff:ff:ff:ff). { return (address[0]&address[1]&address[2]&address[3]&address[4]&address[5])==0xff; }

bool MACAddress::isMulticast (   )  const [inline]

Returns true this is a multicast logical address (starts with bit 1). {return address[0]&0x80;};

bool MACAddress::isUnspecified (   )  const

Returns true if all address bytes are zero. { return !(address[0] || address[1] || address[2] || address[3] || address[4] || address[5]); }

MACAddress & MACAddress::operator= (  const MACAddress &  other  )

Assignment. { memcpy(address, other.address, MAC_ADDRESS_BYTES); return *this; }

bool MACAddress::operator== (  const MACAddress &  other  )  const [inline]

Returns true if the two addresses are equal. {return (*this).equals(other);}

void MACAddress::setAddress (  const char *  hexstr  )

Converts address value from hex string. The string "auto" is also accepted, it'll generate a unique address starting with "A0 00". { if (!hexstr) throw new cException("MACAddress::setAddress(const char *): got null pointer"); if (hextobin(hexstr, address, MAC_ADDRESS_BYTES)!=MAC_ADDRESS_BYTES) throw new cException("MACAddress::setAddress(const char *): hex string \"%s\" too short, should be 12 hex digits", hexstr); }

void MACAddress::setAddress (  unsigned int  k, unsigned char  addrbyte )

Sets the kth byte of the address. { if (k>=6) throw new cException("Array of size 6 indexed with %d", k); address[k] = addrbyte; }

void MACAddress::setAddressBytes (  unsigned char *  addrbytes  )

Sets address bytes. The argument should point to an array of 6 unsigned chars. { memcpy(address, addrbytes, MAC_ADDRESS_BYTES); }

void MACAddress::setBroadcast (   )

Sets the address to the broadcast address (hex ff:ff:ff:ff:ff:ff). { address[0]=address[1]=address[2]=address[3]=address[4]=address[5]=0xff; }

std::string MACAddress::str (   )  const

Converts address to a hex string. { char buf[20]; char *s = buf; for (int i=0; i<MAC_ADDRESS_BYTES; i++, s+=3) sprintf(s,"%2.2X-",address[i]); *(s-1)='\0'; return std::string(buf); }

---

Member Data Documentation

unsigned char MACAddress::address[6] [private]

unsigned int MACAddress::autoAddressCtr [static, private]

const MACAddress MACAddress::BROADCAST_ADDRESS [static]

Returns the broadcast (ff:ff:ff:ff:ff:ff) MAC address

const MACAddress MACAddress::UNSPECIFIED_ADDRESS [static]

Returns the unspecified (null) MAC address

---

The documentation for this class was generated from the following files:

• MACAddress.h
• MACAddress.cc

---