The IPv4 representation of a network interface. More...

#include "ipv4-interface.h"

Inheritance diagram for ns3::Ipv4Interface:

Collaboration diagram for ns3::Ipv4Interface:

Public Member Functions
	Ipv4Interface ()
	By default, Ipv4 interface are created in the "down" state with no IP addresses. More...

	Ipv4Interface (const Ipv4Interface &)=delete

	~Ipv4Interface () override

bool	AddAddress (Ipv4InterfaceAddress address)

void	AddAddressCallback (Callback< void, Ptr< Ipv4Interface >, Ipv4InterfaceAddress > addAddressCallback)
	This callback is set when an address is added from an interface with auto-generated Arp cache and it allow the neighbor cache helper to update neighbor's Arp cache. More...

Ipv4InterfaceAddress	GetAddress (uint32_t index) const

Ptr< ArpCache >	GetArpCache () const

Ptr< NetDevice >	GetDevice () const

uint16_t	GetMetric () const

uint32_t	GetNAddresses () const

bool	IsDown () const

bool	IsForwarding () const

bool	IsUp () const
	These are IP interface states and may be distinct from NetDevice states, such as found in real implementations (where the device may be down but IP interface state is still up). More...

Ipv4Interface &	operator= (const Ipv4Interface &)=delete

Ipv4InterfaceAddress	RemoveAddress (Ipv4Address address)
	Remove the given Ipv4 address from the interface. More...

Ipv4InterfaceAddress	RemoveAddress (uint32_t index)

void	RemoveAddressCallback (Callback< void, Ptr< Ipv4Interface >, Ipv4InterfaceAddress > removeAddressCallback)
	This callback is set when an address is removed from an interface with auto-generated Arp cache and it allow the neighbor cache helper to update neighbor's Arp cache. More...

void	Send (Ptr< Packet > p, const Ipv4Header &hdr, Ipv4Address dest)

void	SetArpCache (Ptr< ArpCache > arpCache)
	Set ARP cache used by this interface. More...

void	SetDevice (Ptr< NetDevice > device)
	Set the NetDevice. More...

void	SetDown ()
	Disable this interface. More...

void	SetForwarding (bool val)

void	SetMetric (uint16_t metric)

void	SetNode (Ptr< Node > node)
	Set node associated with interface. More...

void	SetTrafficControl (Ptr< TrafficControlLayer > tc)
	Set the TrafficControlLayer. More...

void	SetUp ()
	Enable this interface. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

	~Object () override
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose ()
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one. More...

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object. More...

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object. More...

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized () const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID. More...

Protected Member Functions
void	DoDispose () override
	Destructor implementation. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoInitialize ()
	Initialize() implementation. More...

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed. More...

Private Types
typedef std::list< Ipv4InterfaceAddress >	Ipv4InterfaceAddressList
	Container for the Ipv4InterfaceAddresses. More...

typedef std::list< Ipv4InterfaceAddress >::const_iterator	Ipv4InterfaceAddressListCI
	Container Iterator for the Ipv4InterfaceAddresses. More...

typedef std::list< Ipv4InterfaceAddress >::iterator	Ipv4InterfaceAddressListI
	Const Container Iterator for the Ipv4InterfaceAddresses. More...

Private Member Functions
void	DoSetup ()
	Initialize interface. More...

Private Attributes
Callback< void, Ptr< Ipv4Interface >, Ipv4InterfaceAddress >	m_addAddressCallback
	add address callback More...

Ptr< ArpCache >	m_cache
	ARP cache. More...

Ptr< NetDevice >	m_device
	The associated NetDevice. More...

bool	m_forwarding
	Forwarding state. More...

Ipv4InterfaceAddressList	m_ifaddrs
	Address list. More...

bool	m_ifup
	The state of this interface. More...

uint16_t	m_metric
	Interface metric. More...

Ptr< Node >	m_node
	The associated node. More...

Callback< void, Ptr< Ipv4Interface >, Ipv4InterfaceAddress >	m_removeAddressCallback
	remove address callback More...

Ptr< TrafficControlLayer >	m_tc
	The associated TrafficControlLayer. More...

Additional Inherited Members
Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

The IPv4 representation of a network interface.

This class roughly corresponds to the struct in_device of Linux; the main purpose is to provide address-family specific information (addresses) about an interface.

By default, Ipv4 interface are created in the "down" state no IP addresses. Before becoming usable, the user must add an address of some type and invoke Setup on them.

Definition at line 54 of file ipv4-interface.h.

Member Typedef Documentation

◆ Ipv4InterfaceAddressList

typedef std::list<Ipv4InterfaceAddress> ns3::Ipv4Interface::Ipv4InterfaceAddressList

private

Container for the Ipv4InterfaceAddresses.

Definition at line 228 of file ipv4-interface.h.

◆ Ipv4InterfaceAddressListCI

typedef std::list<Ipv4InterfaceAddress>::const_iterator ns3::Ipv4Interface::Ipv4InterfaceAddressListCI

private

Container Iterator for the Ipv4InterfaceAddresses.

Definition at line 233 of file ipv4-interface.h.

◆ Ipv4InterfaceAddressListI

typedef std::list<Ipv4InterfaceAddress>::iterator ns3::Ipv4Interface::Ipv4InterfaceAddressListI

private

Const Container Iterator for the Ipv4InterfaceAddresses.

Definition at line 238 of file ipv4-interface.h.

Constructor & Destructor Documentation

◆ Ipv4Interface() [1/2]

ns3::Ipv4Interface::Ipv4Interface ( )

By default, Ipv4 interface are created in the "down" state with no IP addresses.

Before becoming usable, the user must invoke SetUp on them once an Ipv4 address and mask have been set.

Definition at line 63 of file ipv4-interface.cc.

References NS_LOG_FUNCTION.

◆ ~Ipv4Interface()

ns3::Ipv4Interface::~Ipv4Interface ( )

override

Definition at line 75 of file ipv4-interface.cc.

References NS_LOG_FUNCTION.

◆ Ipv4Interface() [2/2]

ns3::Ipv4Interface::Ipv4Interface ( const Ipv4Interface & )

delete

Member Function Documentation

◆ AddAddress()

bool ns3::Ipv4Interface::AddAddress ( Ipv4InterfaceAddress address )

Parameters

address The Ipv4InterfaceAddress to add to the interface

Returns: true if succeeded

Definition at line 322 of file ipv4-interface.cc.

References m_addAddressCallback, m_ifaddrs, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3ClickProtocol::AddAddress(), ns3::Ipv4L3Protocol::AddAddress(), AddIpv4Address(), DynamicNeighborCacheTest::AddIpv4Address(), and DynamicPartialTest::AddIpv4Address().

Here is the caller graph for this function:

◆ AddAddressCallback()

void ns3::Ipv4Interface::AddAddressCallback ( Callback< void, Ptr< Ipv4Interface >, Ipv4InterfaceAddress > addAddressCallback )

This callback is set when an address is added from an interface with auto-generated Arp cache and it allow the neighbor cache helper to update neighbor's Arp cache.

Parameters

addAddressCallback Callback when remove an address.

Definition at line 423 of file ipv4-interface.cc.

References m_addAddressCallback, and NS_LOG_FUNCTION.

Referenced by ns3::NeighborCacheHelper::PopulateNeighborEntriesIpv4().

Here is the caller graph for this function:

◆ DoDispose()

void ns3::Ipv4Interface::DoDispose ( void )

overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 81 of file ipv4-interface.cc.

References ns3::Object::DoDispose(), m_cache, m_device, m_node, m_tc, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoSetup()

void ns3::Ipv4Interface::DoSetup ( )

private

Initialize interface.

Definition at line 115 of file ipv4-interface.cc.

References ns3::Object::GetObject(), m_cache, m_device, m_node, and NS_LOG_FUNCTION.

Referenced by SetDevice(), and SetNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAddress()

Ipv4InterfaceAddress ns3::Ipv4Interface::GetAddress ( uint32_t index ) const

Parameters

index Index of Ipv4InterfaceAddress to return

Returns: The Ipv4InterfaceAddress address whose index is i

Definition at line 334 of file ipv4-interface.cc.

References m_ifaddrs, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3ClickProtocol::GetAddress(), ns3::Ipv4L3Protocol::GetAddress(), ns3::Ipv4EndPointDemux::Lookup(), ns3::NeighborCacheHelper::PopulateNeighborEntriesIpv4(), ns3::ArpL3Protocol::Receive(), ns3::Icmpv4L4Protocol::Receive(), ns3::Ipv4L3Protocol::Send(), and ns3::NeighborCacheHelper::UpdateCacheByIpv4AddressAdded().

Here is the caller graph for this function:

◆ GetArpCache()

Ptr< ArpCache > ns3::Ipv4Interface::GetArpCache ( ) const

Returns: ARP cache used by this interface

Definition at line 159 of file ipv4-interface.cc.

References m_cache, and NS_LOG_FUNCTION.

Referenced by ns3::NeighborCacheHelper::AddEntry(), FlushTest::DoRun(), ns3::NeighborCacheHelper::FlushAutoGenerated(), GetTypeId(), ns3::Ipv4L3Protocol::Receive(), and ns3::NeighborCacheHelper::UpdateCacheByIpv4AddressRemoved().

Here is the caller graph for this function:

◆ GetDevice()

Ptr< NetDevice > ns3::Ipv4Interface::GetDevice ( ) const

Returns: the underlying NetDevice. This method cannot return zero.

Definition at line 131 of file ipv4-interface.cc.

References m_device, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3ClickProtocol::AddIpv4Interface(), ns3::Ipv4L3Protocol::AddIpv4Interface(), ns3::Ipv4RawSocketImpl::ForwardUp(), ns3::UdpSocketImpl::ForwardUp(), ns3::Ipv4L3ClickProtocol::GetMtu(), ns3::Ipv4L3Protocol::GetMtu(), ns3::Ipv4L3ClickProtocol::GetNetDevice(), ns3::Ipv4L3Protocol::GetNetDevice(), ns3::Ipv4EndPointDemux::Lookup(), ns3::NeighborCacheHelper::PopulateNeighborCache(), ns3::NeighborCacheHelper::PopulateNeighborEntriesIpv4(), ns3::Ipv4L3Protocol::Send(), ns3::Ipv4L3Protocol::SendRealOut(), ns3::NeighborCacheHelper::UpdateCacheByIpv4AddressAdded(), and ns3::NeighborCacheHelper::UpdateCacheByIpv4AddressRemoved().

Here is the caller graph for this function:

◆ GetMetric()

uint16_t ns3::Ipv4Interface::GetMetric ( ) const

Returns: configured routing metric (cost) of this interface

Note: This is synonymous to the Metric value that ifconfig prints out. It is used by ns-3 global routing, but other routing daemons may choose to ignore it.

Definition at line 145 of file ipv4-interface.cc.

References m_metric, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3ClickProtocol::GetMetric(), and ns3::Ipv4L3Protocol::GetMetric().

Here is the caller graph for this function:

◆ GetNAddresses()

uint32_t ns3::Ipv4Interface::GetNAddresses ( ) const

Returns: the number of Ipv4InterfaceAddress stored on this interface

Definition at line 315 of file ipv4-interface.cc.

References m_ifaddrs, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3ClickProtocol::GetNAddresses(), ns3::Ipv4L3Protocol::GetNAddresses(), ns3::Ipv4EndPointDemux::Lookup(), ns3::NeighborCacheHelper::PopulateNeighborEntriesIpv4(), ns3::Icmpv4L4Protocol::Receive(), ns3::Ipv4L3Protocol::Send(), and ns3::NeighborCacheHelper::UpdateCacheByIpv4AddressAdded().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::Ipv4Interface::GetTypeId ( void )

static

Get the type ID.

Returns: type ID

Definition at line 43 of file ipv4-interface.cc.

References GetArpCache(), ns3::MakePointerAccessor(), SetArpCache(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ IsDown()

bool ns3::Ipv4Interface::IsDown ( ) const

Returns: true if this interface is disabled, false otherwise.

Definition at line 178 of file ipv4-interface.cc.

References m_ifup, and NS_LOG_FUNCTION.

◆ IsForwarding()

bool ns3::Ipv4Interface::IsForwarding ( ) const

Returns: true if this interface is enabled for IP forwarding of input datagrams

Definition at line 199 of file ipv4-interface.cc.

References m_forwarding, and NS_LOG_FUNCTION.

◆ IsUp()

bool ns3::Ipv4Interface::IsUp ( ) const

These are IP interface states and may be distinct from NetDevice states, such as found in real implementations (where the device may be down but IP interface state is still up).

Returns: true if this interface is enabled, false otherwise.

Definition at line 171 of file ipv4-interface.cc.

References m_ifup, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3ClickProtocol::IsUp(), ns3::Ipv4L3Protocol::IsUp(), ns3::Ipv4L3ClickProtocol::Receive(), ns3::Ipv4L3Protocol::Receive(), Send(), and ns3::Ipv4L3Protocol::SendRealOut().

Here is the caller graph for this function:

◆ operator=()

Ipv4Interface& ns3::Ipv4Interface::operator= ( const Ipv4Interface & )

delete

◆ RemoveAddress() [1/2]

Ipv4InterfaceAddress ns3::Ipv4Interface::RemoveAddress ( Ipv4Address address )

Remove the given Ipv4 address from the interface.

Parameters

address The Ipv4 address to remove

Returns: The removed Ipv4 interface address; The null interface address if the interface did not contain the address or if loopback address was passed as argument

Definition at line 388 of file ipv4-interface.cc.

References first::address, ns3::Ipv4Address::GetLoopback(), m_ifaddrs, m_removeAddressCallback, NS_LOG_FUNCTION, and NS_LOG_WARN.

Here is the call graph for this function:

◆ RemoveAddress() [2/2]

Ipv4InterfaceAddress ns3::Ipv4Interface::RemoveAddress ( uint32_t index )

Parameters

index Index of Ipv4InterfaceAddress to remove

Returns: The Ipv4InterfaceAddress address whose index is index

Definition at line 358 of file ipv4-interface.cc.

References m_ifaddrs, m_removeAddressCallback, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by RemoveIpv4Address(), DynamicNeighborCacheTest::RemoveIpv4Address(), and DynamicPartialTest::RemoveIpv4Address().

Here is the caller graph for this function:

◆ RemoveAddressCallback()

void ns3::Ipv4Interface::RemoveAddressCallback ( Callback< void, Ptr< Ipv4Interface >, Ipv4InterfaceAddress > removeAddressCallback )

This callback is set when an address is removed from an interface with auto-generated Arp cache and it allow the neighbor cache helper to update neighbor's Arp cache.

Parameters

removeAddressCallback Callback when remove an address.

Definition at line 415 of file ipv4-interface.cc.

References m_removeAddressCallback, and NS_LOG_FUNCTION.

Referenced by ns3::NeighborCacheHelper::PopulateNeighborEntriesIpv4().

Here is the caller graph for this function:

◆ Send()

void ns3::Ipv4Interface::Send	(	Ptr< Packet >	p,
		const Ipv4Header &	hdr,
		Ipv4Address	dest
	)

Parameters

p	packet to send
hdr	IPv4 header
dest	next hop address of packet.

This method will eventually call the private SendTo method which must be implemented by subclasses.

Todo:: additional checks needed here (such as whether multicast goes to loopback)?

Definition at line 213 of file ipv4-interface.cc.

References ns3::Packet::AddHeader(), ns3::Object::GetObject(), ns3::Ipv4Address::IsBroadcast(), ns3::Ipv4Address::IsMulticast(), ns3::Ipv4Address::IsSubnetDirectedBroadcast(), IsUp(), m_cache, m_device, m_ifaddrs, m_node, m_tc, NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::NetDevice::PACKET_HOST, ns3::Ipv4L3Protocol::PROT_NUMBER, ns3::TrafficControlLayer::Receive(), and ns3::Simulator::ScheduleNow().

Referenced by ns3::ArpL3Protocol::Receive(), and ns3::Ipv4L3Protocol::SendRealOut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetArpCache()

void ns3::Ipv4Interface::SetArpCache ( Ptr< ArpCache > arpCache )

Set ARP cache used by this interface.

Parameters

arpCache the ARP cache

Definition at line 152 of file ipv4-interface.cc.

References m_cache, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetDevice()

void ns3::Ipv4Interface::SetDevice ( Ptr< NetDevice > device )

Set the NetDevice.

Parameters

device NetDevice

Definition at line 100 of file ipv4-interface.cc.

References DoSetup(), m_device, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetDown()

void ns3::Ipv4Interface::SetDown ( )

Disable this interface.

Definition at line 192 of file ipv4-interface.cc.

References m_ifup, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3ClickProtocol::SetDown(), and ns3::Ipv4L3Protocol::SetDown().

Here is the caller graph for this function:

◆ SetForwarding()

void ns3::Ipv4Interface::SetForwarding ( bool val )

Parameters

val	Whether to enable or disable IP forwarding for input datagrams

Definition at line 206 of file ipv4-interface.cc.

References m_forwarding, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3ClickProtocol::SetForwarding(), and ns3::Ipv4L3Protocol::SetForwarding().

Here is the caller graph for this function:

◆ SetMetric()

void ns3::Ipv4Interface::SetMetric ( uint16_t metric )

Parameters

metric configured routing metric (cost) of this interface

Note: This is synonymous to the Metric value that ifconfig prints out. It is used by ns-3 global routing, but other routing daemons choose to ignore it.

Definition at line 138 of file ipv4-interface.cc.

References m_metric, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv4L3ClickProtocol::SetMetric(), and ns3::Ipv4L3Protocol::SetMetric().

Here is the caller graph for this function: