A class used for addressing MAC8 MAC's. More...

#include "mac8-address.h"

Collaboration diagram for ns3::Mac8Address:

Public Member Functions
	Mac8Address ()=default
	Mac8Address (uint8_t addr)
	Create Mac8Address object with address addr.
virtual	~Mac8Address ()
	Destructor.
Address	ConvertTo () const
	Convert to a generic Address.
void	CopyFrom (const uint8_t *pBuffer)
	Sets address to address stored in parameter.
void	CopyTo (uint8_t *pBuffer) const
	Writes address to buffer parameter.
	operator Address () const
	Create a generic Address.
constexpr std::strong_ordering	operator<=> (const Mac8Address &other) const =default
	Spaceship comparison operator.

Static Public Member Functions
static Mac8Address	Allocate ()
	Allocates Mac8Address from 0-254.
static Mac8Address	ConvertFrom (const Address &address)
	Convert a generic address to a Mac8Address.
static Mac8Address	GetBroadcast ()
	Get the broadcast address (255).
static bool	IsMatchingType (const Address &address)
	Check that a generic Address is compatible with Mac8Address.
static void	ResetAllocationIndex ()
	Reset the Mac8Address allocation index.

Static Private Member Functions
static uint8_t	GetType ()
	Get the Mac8Address type.

Private Attributes
uint8_t	m_address {255}
	The address.

Static Private Attributes
static uint8_t	m_allocationIndex = 0
	Address allocation index.

Friends
std::ostream &	operator<< (std::ostream &os, const Mac8Address &address)
	Write address to stream os as 8 bit integer.
std::istream &	operator>> (std::istream &is, Mac8Address &address)
	Read address from stream is as 8 bit integer.

Detailed Description

A class used for addressing MAC8 MAC's.

This implementation uses a simple 8 bit flat addressing scheme. It is unlikely that perceived underwater networks will soon exceed 200 nodes (or the overlapping of two underwater networks

the ocean is big), so this should provide adequate addressing for most applications.

Definition at line 33 of file mac8-address.h.

Constructor & Destructor Documentation

◆ Mac8Address() [1/2]

ns3::Mac8Address::Mac8Address ( )

default

References Mac8Address().

Referenced by Mac8Address(), Allocate(), ConvertFrom(), GetBroadcast(), operator<<, operator<=>(), and operator>>.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Mac8Address() [2/2]

ns3::Mac8Address::Mac8Address ( uint8_t addr )

Create Mac8Address object with address addr.

Parameters

addr	Byte address to assign to this address.

Definition at line 22 of file mac8-address.cc.

References m_address.

◆ ~Mac8Address()

ns3::Mac8Address::~Mac8Address ( )

virtual

Destructor.

Definition at line 27 of file mac8-address.cc.

Member Function Documentation

◆ Allocate()

Mac8Address ns3::Mac8Address::Allocate ( )

static

Allocates Mac8Address from 0-254.

Will wrap back to 0 if more than 254 are allocated. Excludes the broadcast address.

Returns: The next sequential Mac8Address.

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

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

Referenced by UanTest::CreateNode(), and ns3::UanHelper::Install().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConvertFrom()

Mac8Address ns3::Mac8Address::ConvertFrom ( const Address & address )

static

Convert a generic address to a Mac8Address.

Parameters

address Address to convert to Mac8Address address.

Returns: Mac8Address from Address.

Definition at line 45 of file mac8-address.cc.

References Mac8Address(), IsMatchingType(), m_address, and NS_ASSERT.

Referenced by ns3::UanMacRc::Associate(), ns3::UanMacRc::AssociateTimeout(), ns3::UanMacRcGw::EndCycle(), ns3::UanMacAloha::Enqueue(), ns3::UanMacCw::Enqueue(), ns3::UanMacRc::Enqueue(), ns3::UanMacRc::IsPhy1Ok(), ns3::Ipv6Address::MakeAutoconfiguredAddress(), ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress(), ns3::Ipv6AddressHelper::NewAddress(), ns3::UanMacCw::PhyRxPacketGood(), ns3::UanMacRc::ProcessAck(), ns3::UanMacRc::ReceiveOkFromPhy(), ns3::UanMacRcGw::ReceivePacket(), ns3::UanMacRc::RtsTimeout(), ns3::UanMacAloha::RxPacketError(), ns3::UanMacRc::ScheduleData(), ns3::UanMacRc::SendPacket(), ns3::UanMacRc::SendRts(), ns3::UanNetDevice::SetAddress(), and ns3::UanMacRcGw::StartCycle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ConvertTo()

Address ns3::Mac8Address::ConvertTo ( ) const

Convert to a generic Address.

Returns: The Address value.

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

References GetType(), and m_address.

Referenced by operator Address().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CopyFrom()

void ns3::Mac8Address::CopyFrom ( const uint8_t * pBuffer )

Sets address to address stored in parameter.

Parameters

pBuffer Buffer to extract address from.

Definition at line 66 of file mac8-address.cc.

References m_address.

◆ CopyTo()

void ns3::Mac8Address::CopyTo ( uint8_t * pBuffer ) const

Writes address to buffer parameter.

Parameters

pBuffer

Definition at line 72 of file mac8-address.cc.

References m_address.

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

Here is the caller graph for this function:

◆ GetBroadcast()

Mac8Address ns3::Mac8Address::GetBroadcast ( )

static

Get the broadcast address (255).

Returns: Broadcast address.

Definition at line 78 of file mac8-address.cc.

References Mac8Address().

Referenced by ns3::UanMacRc::Associate(), ns3::UanMacRc::AssociateTimeout(), ns3::UanMacCw::PhyRxPacketGood(), ns3::UanMacRc::ReceiveOkFromPhy(), ns3::UanMacRcGw::ReceivePacket(), ns3::UanMacRc::RtsTimeout(), ns3::UanMacAloha::RxPacketGood(), ns3::UanMacRc::SendRts(), and ns3::UanMacRcGw::StartCycle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetType()

uint8_t ns3::Mac8Address::GetType ( )

staticprivate

Get the Mac8Address type.

Returns: The type value.

Definition at line 32 of file mac8-address.cc.

References ns3::Address::Register().

Referenced by ConvertTo(), and IsMatchingType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsMatchingType()

bool ns3::Mac8Address::IsMatchingType ( const Address & address )

static

Check that a generic Address is compatible with Mac8Address.

Parameters

address Address to test.

Returns: True if address given is consistent with Mac8Address.

Definition at line 54 of file mac8-address.cc.

References GetType().

Referenced by ConvertFrom(), ns3::MockNetDevice::IsBroadcast(), ns3::MockNetDevice::IsMulticast(), ns3::Ipv6Address::MakeAutoconfiguredAddress(), ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress(), and ns3::Ipv6AddressHelper::NewAddress().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator Address()

ns3::Mac8Address::operator Address ( ) const

Create a generic Address.

Returns: The Address.

Definition at line 59 of file mac8-address.cc.

References ConvertTo().

Here is the call graph for this function:

◆ operator<=>()

std::strong_ordering ns3::Mac8Address::operator<=> ( const Mac8Address & other ) const

constexprdefault

Spaceship comparison operator.

All the other comparison operators are automatically generated from this one.

Parameters

other address to compare to this one

Returns: The result of the comparison.

References Mac8Address().

Here is the call graph for this function:

◆ ResetAllocationIndex()

void ns3::Mac8Address::ResetAllocationIndex ( )

static

Reset the Mac8Address 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 103 of file mac8-address.cc.

References m_allocationIndex, and NS_LOG_FUNCTION_NOARGS.

Referenced by Allocate().

Here is the caller graph for this function:

◆ operator<<

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

friend

Write address to stream os as 8 bit integer.

Parameters

os	The output stream.
address	The address

Returns: The output stream.

Definition at line 110 of file mac8-address.cc.

References Mac8Address().

◆ operator>>

std::istream & operator>>	(	std::istream &	is,
		Mac8Address &	address )

friend

Read address from stream is as 8 bit integer.

Parameters

is	The input stream.
address	The address variable to set.

Returns: The input stream.

Definition at line 118 of file mac8-address.cc.

References Mac8Address(), NS_ASSERT, and x.

Member Data Documentation

◆ m_address

uint8_t ns3::Mac8Address::m_address {255}

private

The address.

Definition at line 133 of file mac8-address.h.

Referenced by Mac8Address(), ConvertFrom(), ConvertTo(), CopyFrom(), and CopyTo().

◆ m_allocationIndex

uint8_t ns3::Mac8Address::m_allocationIndex = 0

staticprivate

Address allocation index.

Definition at line 132 of file mac8-address.h.

Referenced by Allocate(), and ResetAllocationIndex().

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

src/network/utils/mac8-address.h
src/network/utils/mac8-address.cc

Public Member Functions

Static Public Member Functions

Static Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Mac8Address() [1/2]

◆ Mac8Address() [2/2]

◆ ~Mac8Address()

Member Function Documentation

◆ Allocate()

◆ ConvertFrom()

◆ ConvertTo()

◆ CopyFrom()

◆ CopyTo()

◆ GetBroadcast()

◆ GetType()

◆ IsMatchingType()

◆ operator Address()

◆ operator<=>()

◆ ResetAllocationIndex()

Friends And Related Symbol Documentation

◆ operator<<

◆ operator>>

Member Data Documentation

◆ m_address

◆ m_allocationIndex