ns3::Ipv4InterfaceAddress Class Reference

a class to store IPv4 address information on an interface More...

#include "ipv4-interface-address.h"

Public Types
enum	InterfaceAddressScope_e { HOST, LINK, GLOBAL }
	Address scope. More...

Public Member Functions
	Ipv4InterfaceAddress ()
	Ipv4InterfaceAddress (Ipv4Address local, Ipv4Mask mask)
	Configure local address, mask and broadcast address. More...
	Ipv4InterfaceAddress (const Ipv4InterfaceAddress &o)
	Copy constructor. More...
Ipv4Address	GetBroadcast (void) const
	Get the broadcast address. More...
Ipv4Address	GetLocal (void) const
	Get the local address. More...
Ipv4Mask	GetMask (void) const
	Get the network mask. More...
Ipv4InterfaceAddress::InterfaceAddressScope_e	GetScope (void) const
	Get address scope. More...
bool	IsSecondary (void) const
	Check if the address is a secondary address. More...
void	SetBroadcast (Ipv4Address broadcast)
	Set the broadcast address. More...
void	SetLocal (Ipv4Address local)
	Set local address. More...
void	SetMask (Ipv4Mask mask)
	Set the network mask. More...
void	SetPrimary (void)
	Make the address primary. More...
void	SetScope (Ipv4InterfaceAddress::InterfaceAddressScope_e scope)
	Set the scope. More...
void	SetSecondary (void)
	Make the address secondary (used for multihoming) More...

Private Attributes
Ipv4Address	m_broadcast
	Broadcast address. More...
Ipv4Address	m_local
	Interface address. More...
Ipv4Mask	m_mask
	Network mask. More...
InterfaceAddressScope_e	m_scope
	Address scope. More...
bool	m_secondary
	For use in multihoming. More...

Friends
bool	operator!= (Ipv4InterfaceAddress const &a, Ipv4InterfaceAddress const &b)
	Not equal to operator. More...
bool	operator== (Ipv4InterfaceAddress const &a, Ipv4InterfaceAddress const &b)
	Equal to operator. More...

Detailed Description

a class to store IPv4 address information on an interface

Corresponds to Linux struct in_ifaddr. A list of these addresses is stored in Ipv4Interface. This class is modelled after how current Linux handles IP aliasing for IPv4. Notably, aliasing of IPv4 interfaces (e.g., "eth0:1") is not used, and instead an interface is assigned possibly multiple addresses, with each address being classified as being primary and secondary. See the iproute2 documentation for this distinction.

Definition at line 43 of file ipv4-interface-address.h.

Member Enumeration Documentation

InterfaceAddressScope_e

enum ns3::Ipv4InterfaceAddress::InterfaceAddressScope_e

Address scope.

Enumerator
HOST
LINK
GLOBAL

Definition at line 50 of file ipv4-interface-address.h.

Constructor & Destructor Documentation

Ipv4InterfaceAddress() [1/3]

ns3::Ipv4InterfaceAddress::Ipv4InterfaceAddress

(

)

Definition at line 29 of file ipv4-interface-address.cc.

References NS_LOG_FUNCTION.

Ipv4InterfaceAddress() [2/3]

ns3::Ipv4InterfaceAddress::Ipv4InterfaceAddress	(	Ipv4Address	local,
		Ipv4Mask	mask
	)

Configure local address, mask and broadcast address.

Parameters

local	the local address
mask	the network mask

Definition at line 36 of file ipv4-interface-address.cc.

References ns3::Ipv4Address::Get(), ns3::Ipv4Mask::Get(), m_broadcast, m_local, m_mask, and NS_LOG_FUNCTION.

Ipv4InterfaceAddress() [3/3]

ns3::Ipv4InterfaceAddress::Ipv4InterfaceAddress

(

const Ipv4InterfaceAddress &

o

)

Copy constructor.

Parameters

o	the object to copy

Definition at line 46 of file ipv4-interface-address.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

GetBroadcast()

Ipv4Address ns3::Ipv4InterfaceAddress::GetBroadcast

(

void

)

const

Get the broadcast address.

Returns

the broadcast address

Definition at line 92 of file ipv4-interface-address.cc.

References m_broadcast, and NS_LOG_FUNCTION.

Referenced by DsdvTableTestCase::DoRun(), ns3::UdpSocketImpl::DoSendTo(), ns3::Ipv4L3Protocol::IsDestinationAddress(), ns3::Ipv4L3Protocol::IsUnicast(), ns3::aodv::RoutingProtocol::NotifyAddAddress(), ns3::dsdv::RoutingProtocol::NotifyAddAddress(), ns3::aodv::RoutingProtocol::NotifyInterfaceUp(), ns3::aodv::RoutingProtocol::NotifyRemoveAddress(), ns3::operator<<(), ns3::aodv::RoutingProtocol::RecvRequest(), ns3::aodv::RoutingProtocol::RouteInput(), ns3::dsdv::RoutingProtocol::RouteInput(), ns3::aodv::RoutingProtocol::SendHello(), ns3::dsdv::RoutingProtocol::SendPeriodicUpdate(), ns3::aodv::RoutingProtocol::SendRequest(), ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward(), and ns3::dsdv::RoutingProtocol::SendTriggeredUpdate().

GetLocal()

Ipv4Address ns3::Ipv4InterfaceAddress::GetLocal

(

void

)

const

Get the local address.

Returns

the local address

Definition at line 64 of file ipv4-interface-address.cc.

References m_local, and NS_LOG_FUNCTION.

Referenced by ns3::NscTcpL4Protocol::AddInterface(), DsdvTableTestCase::DoRun(), ns3::Rip::DoSendRouteUpdate(), ns3::UdpSocketImpl::DoSendTo(), ns3::AnimationInterface::GetIpv4Address(), ns3::AnimationInterface::GetIpv4Addresses(), ns3::Ipv4L3Protocol::IsDestinationAddress(), ns3::aodv::RoutingProtocol::IsMyOwnAddress(), ns3::olsr::RoutingProtocol::IsMyOwnAddress(), ns3::Ipv4L3Protocol::LocalDeliver(), ns3::Ipv4EndPointDemux::Lookup(), ns3::aodv::RoutingProtocol::NotifyAddAddress(), ns3::dsdv::RoutingProtocol::NotifyAddAddress(), ns3::aodv::RoutingProtocol::NotifyInterfaceUp(), ns3::aodv::RoutingProtocol::NotifyRemoveAddress(), ns3::operator<<(), ns3::dsdv::RoutingTableEntry::Print(), ns3::aodv::RoutingTableEntry::Print(), PrintPosition(), ns3::aodv::RoutingProtocol::RouteInput(), ns3::dsdv::RoutingProtocol::RouteInput(), ns3::olsr::RoutingProtocol::RouteInput(), ns3::olsr::RoutingProtocol::RouteOutput(), ns3::dsdv::RoutingTableEntry::RoutingTableEntry(), ns3::aodv::RoutingTableEntry::RoutingTableEntry(), ns3::Ipv4L3Protocol::SelectSourceAddress(), ns3::Ipv4L3Protocol::Send(), ns3::aodv::RoutingProtocol::SendHello(), ns3::aodv::RoutingProtocol::SendRequest(), ns3::aodv::RoutingProtocol::SendRerrMessage(), ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward(), and ns3::Ipv4L3Protocol::SourceAddressSelection().

GetMask()

Ipv4Mask ns3::Ipv4InterfaceAddress::GetMask

(

void

)

const

Get the network mask.

Returns

the network mask

Definition at line 78 of file ipv4-interface-address.cc.

References m_mask, and NS_LOG_FUNCTION.

Referenced by ns3::NscTcpL4Protocol::AddInterface(), ns3::Rip::DoSendRouteUpdate(), ns3::Ipv4L3Protocol::LocalDeliver(), ns3::Ipv4EndPointDemux::Lookup(), ns3::operator<<(), ns3::aodv::RoutingProtocol::RecvRequest(), ns3::Ipv4L3Protocol::SelectSourceAddress(), ns3::Ipv4L3Protocol::Send(), ns3::aodv::RoutingProtocol::SendHello(), ns3::dsdv::RoutingProtocol::SendPeriodicUpdate(), ns3::aodv::RoutingProtocol::SendRequest(), ns3::aodv::RoutingProtocol::SendRerrWhenNoRouteToForward(), ns3::Ipv4RawSocketImpl::SendTo(), and ns3::dsdv::RoutingProtocol::SendTriggeredUpdate().

GetScope()

Ipv4InterfaceAddress::InterfaceAddressScope_e ns3::Ipv4InterfaceAddress::GetScope

(

void

)

const

Get address scope.

Returns

scope

Definition at line 106 of file ipv4-interface-address.cc.

References m_scope, and NS_LOG_FUNCTION.

Referenced by ns3::Rip::DoSendRouteUpdate(), ns3::Rip::HandleRequests(), ns3::operator<<(), and ns3::Ipv4L3Protocol::SelectSourceAddress().

IsSecondary()

bool ns3::Ipv4InterfaceAddress::IsSecondary

(

void

)

const

Check if the address is a secondary address.

Secondary address is used for multihoming

Returns

true if the address is secondary

Definition at line 113 of file ipv4-interface-address.cc.

References m_secondary, and NS_LOG_FUNCTION.

Referenced by ns3::operator<<(), and ns3::Ipv4L3Protocol::SelectSourceAddress().

SetBroadcast()

void ns3::Ipv4InterfaceAddress::SetBroadcast

(

Ipv4Address

broadcast

)

Set the broadcast address.

Parameters

broadcast

the broadcast address

Definition at line 85 of file ipv4-interface-address.cc.

References m_broadcast, and NS_LOG_FUNCTION.

SetLocal()

void ns3::Ipv4InterfaceAddress::SetLocal

(

Ipv4Address

local

)

Set local address.

Parameters

local

the address

Definition at line 57 of file ipv4-interface-address.cc.

References m_local, and NS_LOG_FUNCTION.

SetMask()

void ns3::Ipv4InterfaceAddress::SetMask

(

Ipv4Mask

mask

)

Set the network mask.

Parameters

mask	the network mask

Definition at line 71 of file ipv4-interface-address.cc.

References m_mask, and NS_LOG_FUNCTION.

SetPrimary()

void ns3::Ipv4InterfaceAddress::SetPrimary

(

void

)

Make the address primary.

Definition at line 127 of file ipv4-interface-address.cc.

References m_secondary, and NS_LOG_FUNCTION.

SetScope()

void ns3::Ipv4InterfaceAddress::SetScope

(

Ipv4InterfaceAddress::InterfaceAddressScope_e

scope

)

Set the scope.

Parameters

scope

the scope of address

Definition at line 99 of file ipv4-interface-address.cc.

References m_scope, and NS_LOG_FUNCTION.

SetSecondary()

void ns3::Ipv4InterfaceAddress::SetSecondary

(

void

)

Make the address secondary (used for multihoming)

Definition at line 120 of file ipv4-interface-address.cc.

References m_secondary, and NS_LOG_FUNCTION.

Friends And Related Function Documentation

operator!=

bool operator!= ( Ipv4InterfaceAddress const &  a, Ipv4InterfaceAddress const &  b  )

friend

Not equal to operator.

Parameters

a	the first operand
b	the first operand

Returns

true if the operands are not equal

Definition at line 174 of file ipv4-interface-address.h.

operator==

bool operator== ( Ipv4InterfaceAddress const &  a, Ipv4InterfaceAddress const &  b  )

friend

Equal to operator.

Parameters

a	the first operand
b	the first operand

Returns

true if the operands are equal

Definition at line 169 of file ipv4-interface-address.h.

Member Data Documentation

m_broadcast

Ipv4Address ns3::Ipv4InterfaceAddress::m_broadcast

private

Broadcast address.

Definition at line 136 of file ipv4-interface-address.h.

Referenced by GetBroadcast(), Ipv4InterfaceAddress(), ns3::operator!=(), ns3::operator==(), and SetBroadcast().

m_local

Ipv4Address ns3::Ipv4InterfaceAddress::m_local

private

Interface address.

Definition at line 132 of file ipv4-interface-address.h.

Referenced by GetLocal(), Ipv4InterfaceAddress(), ns3::operator!=(), ns3::operator==(), and SetLocal().

m_mask

Ipv4Mask ns3::Ipv4InterfaceAddress::m_mask

private

Network mask.

Definition at line 135 of file ipv4-interface-address.h.

Referenced by GetMask(), Ipv4InterfaceAddress(), ns3::operator!=(), ns3::operator==(), and SetMask().

m_scope

InterfaceAddressScope_e ns3::Ipv4InterfaceAddress::m_scope

private

Address scope.

Definition at line 138 of file ipv4-interface-address.h.

Referenced by GetScope(), ns3::operator!=(), ns3::operator==(), and SetScope().

m_secondary

bool ns3::Ipv4InterfaceAddress::m_secondary

private

For use in multihoming.

Definition at line 139 of file ipv4-interface-address.h.

Referenced by IsSecondary(), ns3::operator!=(), ns3::operator==(), SetPrimary(), and SetSecondary().

---

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

• src/internet/model/ipv4-interface-address.h
• src/internet/model/ipv4-interface-address.cc