ndn::ethernet::Address Class Reference

represents an Ethernet hardware address More...

#include <ethernet.hpp>

Inheritance diagram for ndn::ethernet::Address:

Collaboration diagram for ndn::ethernet::Address:

Public Member Functions
	Address ()
	Constructs a null Ethernet address (00:00:00:00:00:00) More...
	Address (uint8_t a1, uint8_t a2, uint8_t a3, uint8_t a4, uint8_t a5, uint8_t a6)
	Constructs a new Ethernet address with the given octets. More...
	Address (const uint8_t octets[ADDR_LEN])
	Constructs a new Ethernet address with the given octets. More...
bool	isBroadcast () const
	True if this is a broadcast address (ff:ff:ff:ff:ff:ff) More...
bool	isMulticast () const
	True if this is a multicast address. More...
bool	isNull () const
	True if this is a null address (00:00:00:00:00:00) More...
std::string	toString (char sep= ':') const
	Converts the address to a human-readable string. More...

Static Public Member Functions
static Address	fromString (const std::string &str)
	Creates an Address from a string containing an Ethernet address in hexadecimal notation, with colons or hyphens as separators. More...

Detailed Description

represents an Ethernet hardware address

Definition at line 52 of file ethernet.hpp.

Constructor & Destructor Documentation

ndn::ethernet::Address::Address

(

)

Constructs a null Ethernet address (00:00:00:00:00:00)

Definition at line 38 of file ethernet.cpp.

Referenced by fromString(), and isNull().

ndn::ethernet::Address::Address	(	uint8_t	a1,
		uint8_t	a2,
		uint8_t	a3,
		uint8_t	a4,
		uint8_t	a5,
		uint8_t	a6
	)

Constructs a new Ethernet address with the given octets.

Definition at line 43 of file ethernet.cpp.

ndn::ethernet::Address::Address ( const uint8_t  octets[ADDR_LEN] )

explicit

Constructs a new Ethernet address with the given octets.

Definition at line 53 of file ethernet.cpp.

Member Function Documentation

bool ndn::ethernet::Address::isBroadcast

(

)

const

True if this is a broadcast address (ff:ff:ff:ff:ff:ff)

Definition at line 59 of file ethernet.cpp.

References ndn::ethernet::getBroadcastAddress().

Referenced by nfd::face::MulticastEthernetTransport::MulticastEthernetTransport().

bool ndn::ethernet::Address::isMulticast

(

)

const

True if this is a multicast address.

Definition at line 65 of file ethernet.cpp.

Referenced by nfd::face::EthernetFactory::createFace(), nfd::face::EthernetFactory::createMulticastFace(), nfd::face::EthernetTransport::doClose(), nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), and nfd::face::EthernetTransport::receivePayload().

bool ndn::ethernet::Address::isNull

(

)

const

True if this is a null address (00:00:00:00:00:00)

Definition at line 71 of file ethernet.cpp.

References Address().

Referenced by nfd::face::EthernetFactory::createMulticastFace(), and nfd::parseList().

std::string ndn::ethernet::Address::toString

(

char

sep = ':'

)

const

Converts the address to a human-readable string.

Parameters

sep	A character used to visually separate the octets, usually ':' (the default value) or '-'

Definition at line 77 of file ethernet.cpp.

Referenced by nfd::ethernet::checkFrameHeader(), nfd::doesMatchRule(), ndn::EtherCanonizeProvider::isCanonical(), nfd::face::MulticastEthernetTransport::MulticastEthernetTransport(), ndn::ethernet::operator<<(), and nfd::face::UnicastEthernetTransport::UnicastEthernetTransport().

Address ndn::ethernet::Address::fromString ( const std::string &  str )

static

Creates an Address from a string containing an Ethernet address in hexadecimal notation, with colons or hyphens as separators.

Parameters

str	The string to be parsed

Returns

Always an instance of Address, which will be null if the parsing fails

Definition at line 91 of file ethernet.cpp.

References Address().

Referenced by ndn::EtherCanonizeProvider::canonize(), nfd::face::EthernetFactory::createFace(), ndn::EtherCanonizeProvider::isCanonical(), nfd::parseList(), and nfd::face::EthernetFactory::processConfig().

---

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

• ndnSIM/ndn-cxx/src/net/ethernet.hpp
• ndnSIM/ndn-cxx/src/net/ethernet.cpp