A Discrete-Event Network Simulator
API
ns3::Mac48Address Class Reference

an EUI-48 address More...

#include "mac48-address.h"

Public Types

typedef void(* TracedCallback) (Mac48Address value)
 TracedCallback signature for Mac48Address. More...
 

Public Member Functions

 Mac48Address ()
 
 Mac48Address (const char *str)
 
void CopyFrom (const uint8_t buffer[6])
 
void CopyTo (uint8_t buffer[6]) const
 
bool IsBroadcast (void) const
 
bool IsGroup (void) const
 
 operator Address () const
 

Static Public Member Functions

static Mac48Address Allocate (void)
 Allocate a new Mac48Address. More...
 
static Mac48Address ConvertFrom (const Address &address)
 
static Mac48Address GetBroadcast (void)
 
static Mac48Address GetMulticast (Ipv4Address address)
 
static Mac48Address GetMulticast (Ipv6Address address)
 Get multicast address from IPv6 address. More...
 
static Mac48Address GetMulticast6Prefix (void)
 Get the multicast prefix for IPv6 (33:33:00:00:00:00). More...
 
static Mac48Address GetMulticastPrefix (void)
 
static bool IsMatchingType (const Address &address)
 

Private Member Functions

Address ConvertTo (void) const
 

Static Private Member Functions

static uint8_t GetType (void)
 Return the Type of address. More...
 

Private Attributes

uint8_t m_address [6]
 address value More...
 

Friends

bool operator!= (const Mac48Address &a, const Mac48Address &b)
 Not equal to operator. More...
 
bool operator< (const Mac48Address &a, const Mac48Address &b)
 Less than operator. More...
 
std::ostream & operator<< (std::ostream &os, const Mac48Address &address)
 Stream insertion operator. More...
 
bool operator== (const Mac48Address &a, const Mac48Address &b)
 Equal to operator. More...
 
std::istream & operator>> (std::istream &is, Mac48Address &address)
 Stream extraction operator. More...
 

Detailed Description

an EUI-48 address

This class can contain 48 bit IEEE addresses.

See also
Mac48Address Attribute

Definition at line 43 of file mac48-address.h.

Member Typedef Documentation

◆ TracedCallback

typedef void(* ns3::Mac48Address::TracedCallback) (Mac48Address value)

TracedCallback signature for Mac48Address.

Parameters
[in]valueCurrent value of the Mac48Address

Definition at line 137 of file mac48-address.h.

Constructor & Destructor Documentation

◆ Mac48Address() [1/2]

ns3::Mac48Address::Mac48Address ( )

Definition at line 60 of file mac48-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by GetBroadcast(), GetMulticast6Prefix(), and GetMulticastPrefix().

+ Here is the caller graph for this function:

◆ Mac48Address() [2/2]

ns3::Mac48Address::Mac48Address ( const char *  str)
Parameters
stra string representing the new Mac48Address

The format of the string is "xx:xx:xx:xx:xx:xx"

Definition at line 65 of file mac48-address.cc.

References ASCII_a, ASCII_COLON, ASCII_ZERO, ns3::AsciiToLowCase(), m_address, NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Member Function Documentation

◆ Allocate()

◆ ConvertFrom()

Mac48Address ns3::Mac48Address::ConvertFrom ( const Address address)
static
Parameters
addressa polymorphic address
Returns
a new Mac48Address from the polymorphic address

This function performs a type check and asserts if the type of the input address is not compatible with an Mac48Address.

Definition at line 126 of file mac48-address.cc.

References first::address, GetType(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::AddAutoconfiguredAddress(), ns3::BridgeNetDevice::AddBridgePort(), ns3::MeshPointDevice::AddInterface(), AddSimpleNetDevice(), ns3::TapBridge::CreateTap(), ns3::Ipv6Interface::DoSetup(), ns3::TapBridge::ForwardToBridgedDevice(), ns3::dot11s::PeerManagementProtocol::Install(), ns3::dot11s::HwmpProtocol::Install(), ns3::flame::FlameProtocol::Install(), ns3::aodv::Neighbors::LookupMacAddress(), ns3::dsr::DsrRouteCache::LookupMacAddress(), ns3::Ipv6Address::MakeAutoconfiguredAddress(), ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress(), ns3::Ipv6AddressHelper::NewAddress(), ns3::dsr::DsrRouting::PromiscReceive(), ns3::TapBridge::ReceiveFromBridgedDevice(), ns3::MeshPointDevice::ReceiveFromDevice(), ns3::BridgeNetDevice::ReceiveFromDevice(), ns3::Ipv6L3Protocol::RemoveAutoconfiguredAddress(), ns3::MeshHelper::Report(), ns3::LoopbackNetDevice::Send(), ns3::MeshPointDevice::Send(), ns3::WifiNetDevice::Send(), ns3::WaveNetDevice::Send(), ns3::WimaxNetDevice::Send(), ns3::LoopbackNetDevice::SendFrom(), ns3::MeshPointDevice::SendFrom(), ns3::SimpleNetDevice::SendFrom(), ns3::BridgeNetDevice::SendFrom(), ns3::WifiNetDevice::SendFrom(), ns3::FdNetDevice::SendFrom(), ns3::AlohaNoackNetDevice::SendFrom(), ns3::CsmaNetDevice::SendFrom(), ns3::WimaxNetDevice::SendFrom(), ns3::WaveNetDevice::SendX(), ns3::LoopbackNetDevice::SetAddress(), ns3::MeshPointDevice::SetAddress(), ns3::SimpleNetDevice::SetAddress(), ns3::BridgeNetDevice::SetAddress(), ns3::WifiNetDevice::SetAddress(), ns3::LrWpanNetDevice::SetAddress(), ns3::FdNetDevice::SetAddress(), ns3::PointToPointNetDevice::SetAddress(), ns3::AlohaNoackNetDevice::SetAddress(), ns3::TapBridge::SetAddress(), ns3::CsmaNetDevice::SetAddress(), ns3::WimaxNetDevice::SetAddress(), and ns3::WaveNetDevice::SetAddress().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ConvertTo()

Address ns3::Mac48Address::ConvertTo ( void  ) const
private
Returns
a new Address instance

Convert an instance of this class to a polymorphic Address instance.

Definition at line 120 of file mac48-address.cc.

References GetType(), m_address, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ CopyFrom()

void ns3::Mac48Address::CopyFrom ( const uint8_t  buffer[6])
Parameters
bufferaddress in network order

Copy the input address to our internal buffer.

Definition at line 97 of file mac48-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::LrWpanNetDevice::BuildPseudoMacAddress(), ns3::TapBridge::CreateTap(), ns3::SimpleTag::Deserialize(), ns3::flame::FlameTag::Deserialize(), ns3::dot11s::HwmpTag::Deserialize(), GetMulticast(), and ns3::ReadFrom().

+ Here is the caller graph for this function:

◆ CopyTo()

void ns3::Mac48Address::CopyTo ( uint8_t  buffer[6]) const

◆ GetBroadcast()

Mac48Address ns3::Mac48Address::GetBroadcast ( void  )
static
Returns
the broadcast address

Definition at line 170 of file mac48-address.cc.

References Mac48Address(), and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::NoBackhaulEpcHelper::AddEnb(), ns3::dot11s::PeerLink::ConfirmAccept(), ns3::dot11s::PeerLink::ConfirmReject(), ns3::MeshWifiBeacon::CreateHeader(), ns3::dot11s::HwmpRtable::DeleteProactivePath(), ns3::dot11s::HwmpProtocolMac::ForwardPerr(), ns3::dot11s::HwmpProtocol::ForwardUnicast(), ns3::LteNetDevice::GetBroadcast(), ns3::WifiNetDevice::GetBroadcast(), ns3::WaveNetDevice::GetBroadcast(), ns3::WimaxNetDevice::GetBroadcast(), ns3::dot11s::HwmpProtocol::GetBroadcastReceivers(), ns3::dot11s::HwmpProtocol::GetPreqReceivers(), ns3::flame::FlameProtocol::HandleDataFrame(), IsBroadcast(), ns3::dot11s::HwmpRtable::LookupResult::IsValid(), ns3::flame::FlameRtable::LookupResult::IsValid(), ns3::dot11s::IePreq::MayAddAddress(), ns3::QosTxop::NotifyInternalCollision(), ns3::dot11s::PeerLink::OpenAccept(), ns3::dot11s::PeerLink::OpenReject(), ns3::dot11s::HwmpProtocol::ProactivePathResolved(), ns3::dot11s::HwmpProtocol::ReactivePathResolved(), ns3::flame::FlameProtocolMac::Receive(), ns3::MeshWifiInterfaceMac::Receive(), ns3::dot11s::PeerManagementProtocol::ReceiveBeacon(), ns3::dot11s::HwmpProtocolMac::ReceiveData(), ns3::dot11s::HwmpProtocol::ReceivePrep(), ns3::dot11s::HwmpProtocol::ReceivePreq(), ns3::flame::FlameProtocol::RemoveRoutingStuff(), ns3::dot11s::HwmpProtocol::RequestRoute(), ns3::flame::FlameProtocol::RequestRoute(), ns3::dot11s::HwmpProtocol::RetryPathDiscovery(), ns3::ApWifiMac::SendCfEnd(), ns3::MeshWifiInterfaceMac::SendManagementFrame(), ns3::ApWifiMac::SendOneBeacon(), WaveNetDeviceExample::SendOneWsmpPacket(), ns3::dot11s::HwmpProtocol::SendProactivePreq(), ns3::StaWifiMac::SendProbeRequest(), WaveNetDeviceExample::SendWsaExample(), ns3::dot11s::PeerLink::StateMachine(), and ns3::flame::FlameProtocolMac::UpdateOutcomingFrame().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetMulticast() [1/2]

◆ GetMulticast() [2/2]

Mac48Address ns3::Mac48Address::GetMulticast ( Ipv6Address  address)
static

Get multicast address from IPv6 address.

Parameters
addressbase IPv6 address
Returns
a multicast address

Definition at line 227 of file mac48-address.cc.

References CopyFrom(), CopyTo(), GetMulticast6Prefix(), NS_LOG_FUNCTION, and ns3::Ipv6Address::Serialize().

+ Here is the call graph for this function:

◆ GetMulticast6Prefix()

Mac48Address ns3::Mac48Address::GetMulticast6Prefix ( void  )
static

Get the multicast prefix for IPv6 (33:33:00:00:00:00).

Returns
a multicast address.

Definition at line 184 of file mac48-address.cc.

References Mac48Address(), and NS_LOG_FUNCTION_NOARGS.

Referenced by GetMulticast().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetMulticastPrefix()

Mac48Address ns3::Mac48Address::GetMulticastPrefix ( void  )
static
Returns
the multicast prefix (01:00:5e:00:00:00).

Definition at line 177 of file mac48-address.cc.

References Mac48Address(), and NS_LOG_FUNCTION_NOARGS.

Referenced by GetMulticast().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetType()

uint8_t ns3::Mac48Address::GetType ( void  )
staticprivate

Return the Type of address.

Returns
type of address

Definition at line 150 of file mac48-address.cc.

References NS_LOG_FUNCTION_NOARGS, and ns3::Address::Register().

Referenced by ConvertFrom(), ConvertTo(), and IsMatchingType().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ IsBroadcast()

◆ IsGroup()

◆ IsMatchingType()

◆ operator Address()

ns3::Mac48Address::operator Address ( ) const
Returns
a new Address instance

Convert an instance of this class to a polymorphic Address instance.

Definition at line 115 of file mac48-address.cc.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const Mac48Address a,
const Mac48Address b 
)
friend

Not equal to operator.

Parameters
athe first operand
bthe first operand
Returns
true if the operands are not equal

Definition at line 207 of file mac48-address.h.

◆ operator<

bool operator< ( const Mac48Address a,
const Mac48Address b 
)
friend

Less than operator.

Parameters
athe first operand
bthe first operand
Returns
true if the operand a is less than operand b

Definition at line 211 of file mac48-address.h.

◆ operator<<

std::ostream& operator<< ( std::ostream &  os,
const Mac48Address address 
)
friend

Stream insertion operator.

Parameters
osthe stream
addressthe address
Returns
a reference to the stream

Definition at line 249 of file mac48-address.cc.

◆ operator==

bool operator== ( const Mac48Address a,
const Mac48Address b 
)
friend

Equal to operator.

Parameters
athe first operand
bthe first operand
Returns
true if the operands are equal

Definition at line 203 of file mac48-address.h.

◆ operator>>

std::istream& operator>> ( std::istream &  is,
Mac48Address address 
)
friend

Stream extraction operator.

Parameters
isthe stream
addressthe address
Returns
a reference to the stream

Definition at line 267 of file mac48-address.cc.

Member Data Documentation

◆ m_address

uint8_t ns3::Mac48Address::m_address[6]
private

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