A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::Mac64Address Class Reference

an EUI-64 address More...

#include "mac64-address.h"

+ Collaboration diagram for ns3::Mac64Address:

Public Member Functions

 Mac64Address ()=default
 
 Mac64Address (const char *str)
 
 Mac64Address (uint64_t addr)
 
Address ConvertTo () const
 
uint64_t ConvertToInt () const
 
void CopyFrom (const uint8_t buffer[8])
 
void CopyTo (uint8_t buffer[8]) const
 
 operator Address () const
 

Static Public Member Functions

static Mac64Address Allocate ()
 Allocate a new Mac64Address.
 
static Mac64Address ConvertFrom (const Address &address)
 
static bool IsMatchingType (const Address &address)
 
static void ResetAllocationIndex ()
 Reset the Mac64Address allocation index.
 

Static Private Member Functions

static uint8_t GetType ()
 Return the Type of address.
 

Private Attributes

uint8_t m_address [8] {0}
 Address value.
 

Static Private Attributes

static uint64_t m_allocationIndex = 0
 Address allocation index.
 

Friends

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

Detailed Description

an EUI-64 address

This class can contain 64 bit IEEE addresses.

See also
Mac64Address Attribute

Definition at line 45 of file mac64-address.h.

Constructor & Destructor Documentation

◆ Mac64Address() [1/3]

ns3::Mac64Address::Mac64Address ( )
default

◆ Mac64Address() [2/3]

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

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

Definition at line 39 of file mac64-address.cc.

References m_address, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ Mac64Address() [3/3]

ns3::Mac64Address::Mac64Address ( uint64_t  addr)
Parameters
addrThe 64 bit unsigned integer used to create a Mac64Address object.

Create a Mac64Address from an 64 bit unsigned integer.

Definition at line 63 of file mac64-address.cc.

References m_address, and NS_LOG_FUNCTION.

Member Function Documentation

◆ Allocate()

Mac64Address ns3::Mac64Address::Allocate ( )
static

Allocate a new Mac64Address.

Returns
newly allocated mac64Address

Definition at line 137 of file mac64-address.cc.

References m_allocationIndex, NS_LOG_FUNCTION_NOARGS, ResetAllocationIndex(), and ns3::Simulator::ScheduleDestroy().

Referenced by ns3::LrWpanMac::LrWpanMac(), and ns3::LteHelper::InstallSingleUeDevice().

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

◆ ConvertFrom()

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

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

Definition at line 103 of file mac64-address.cc.

References GetType(), m_address, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6Address::MakeAutoconfiguredAddress(), ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress(), ns3::Ipv6AddressHelper::NewAddress(), ns3::SixLowPanMesh::Print(), ns3::LrWpanNetDevice::SetAddress(), and ns3::LteNetDevice::SetAddress().

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

◆ ConvertTo()

Address ns3::Mac64Address::ConvertTo ( ) const
Returns
a new Address instance

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

Definition at line 113 of file mac64-address.cc.

References GetType(), m_address, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ ConvertToInt()

uint64_t ns3::Mac64Address::ConvertToInt ( ) const
Returns
the mac address in a 64 bit unsigned integer.

Convert an instance of this class to a 64 bit unsigned integer.

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

References m_address.

◆ CopyFrom()

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

Copy the input address to our internal buffer.

Definition at line 77 of file mac64-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::LrWpanHelper::CreateAssociatedPan(), ns3::ReadFrom(), and ns3::LrWpanHelper::SetExtendedAddresses().

+ Here is the caller graph for this function:

◆ CopyTo()

void ns3::Mac64Address::CopyTo ( uint8_t  buffer[8]) const
Parameters
bufferaddress in network order

Copy the internal address to the input buffer.

Definition at line 84 of file mac64-address.cc.

References m_address, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6Address::MakeAutoconfiguredAddress(), ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress(), and ns3::WriteTo().

+ Here is the caller graph for this function:

◆ GetType()

uint8_t ns3::Mac64Address::GetType ( )
staticprivate

Return the Type of address.

Returns
type of address

Definition at line 167 of file mac64-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:

◆ IsMatchingType()

bool ns3::Mac64Address::IsMatchingType ( const Address address)
static
Parameters
addressaddress to test
Returns
true if the address matches, false otherwise.

Definition at line 91 of file mac64-address.cc.

References GetType(), and NS_LOG_FUNCTION.

Referenced by ns3::MockNetDevice::IsBroadcast(), ns3::MockNetDevice::IsMulticast(), ns3::Ipv6Address::MakeAutoconfiguredAddress(), ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress(), ns3::Ipv6AddressHelper::NewAddress(), ns3::SixLowPanMesh::Print(), ns3::LrWpanNetDevice::SetAddress(), ns3::SixLowPanMesh::SetFinalDst(), and ns3::SixLowPanMesh::SetOriginator().

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

◆ operator Address()

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

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

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

◆ ResetAllocationIndex()

void ns3::Mac64Address::ResetAllocationIndex ( )
static

Reset the Mac64Address allocation index.

This function resets (to zero) the global integer that is used for unique address allocation. It is automatically called whenever

SimulatorDestroy ();

is called. It may also be optionally called by user code if there is a need to force a reset of this allocation index.

Definition at line 160 of file mac64-address.cc.

References m_allocationIndex, and NS_LOG_FUNCTION_NOARGS.

Referenced by Allocate().

+ Here is the caller graph for this function:

Friends And Related Function Documentation

◆ operator!=

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

Not equal to operator.

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

Definition at line 200 of file mac64-address.h.

◆ operator<

bool operator< ( const Mac64Address a,
const Mac64Address 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 205 of file mac64-address.h.

◆ operator<<

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

Stream insertion operator.

Parameters
osthe stream
addressthe address
Returns
a reference to the stream

Definition at line 174 of file mac64-address.cc.

◆ operator==

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

Equal to operator.

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

Definition at line 194 of file mac64-address.h.

◆ operator>>

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

Stream extraction operator.

Parameters
isthe stream
addressthe address
Returns
a reference to the stream

Definition at line 194 of file mac64-address.cc.

Member Data Documentation

◆ m_address

uint8_t ns3::Mac64Address::m_address[8] {0}
private

Address value.

Definition at line 183 of file mac64-address.h.

Referenced by Mac64Address(), ConvertFrom(), ConvertTo(), ConvertToInt(), CopyFrom(), and CopyTo().

◆ m_allocationIndex

uint64_t ns3::Mac64Address::m_allocationIndex = 0
staticprivate

Address allocation index.

Definition at line 182 of file mac64-address.h.

Referenced by Allocate(), and ResetAllocationIndex().


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