Access to the IPv6 forwarding table, interfaces, and configuration. More...

#include "ipv6.h"

Inheritance diagram for ns3::Ipv6:

Collaboration diagram for ns3::Ipv6:

Public Member Functions
	Ipv6 ()
	Constructor. More...

virtual	~Ipv6 ()
	Destructor. More...

virtual bool	AddAddress (uint32_t interface, Ipv6InterfaceAddress address, bool addOnLinkRoute=true)=0
	Add an address on the specified IPv6 interface. More...

virtual uint32_t	AddInterface (Ptr< NetDevice > device)=0
	Add a NetDevice interface. More...

virtual Ipv6InterfaceAddress	GetAddress (uint32_t interface, uint32_t addressIndex) const =0
	Get IPv6 address on specified IPv6 interface. More...

virtual int32_t	GetInterfaceForAddress (Ipv6Address address) const =0
	Return the interface number of the interface that has been assigned the specified IP address. More...

virtual int32_t	GetInterfaceForDevice (Ptr< const NetDevice > device) const =0
	Get the interface index of the specified NetDevice. More...

virtual int32_t	GetInterfaceForPrefix (Ipv6Address address, Ipv6Prefix mask) const =0
	Return the interface number of first interface found that has an IPv6 address within the prefix specified by the input address and mask parameters. More...

virtual uint16_t	GetMetric (uint32_t interface) const =0
	Get metric for the specified IPv6 interface. More...

virtual uint16_t	GetMtu (uint32_t interface) const =0
	Get MTU for the specified IPv6 interface. More...

virtual uint32_t	GetNAddresses (uint32_t interface) const =0
	Get number of addresses on specified IPv6 interface. More...

virtual Ptr< NetDevice >	GetNetDevice (uint32_t interface)=0
	Get the NetDevice of the specified interface number. More...

virtual uint32_t	GetNInterfaces (void) const =0
	Get number of interfaces. More...

virtual Ptr< IpL4Protocol >	GetProtocol (int protocolNumber) const =0
	Get L4 protocol by protocol number. More...

virtual Ptr< IpL4Protocol >	GetProtocol (int protocolNumber, int32_t interfaceIndex) const =0
	Get L4 protocol by protocol number for the specified interface. More...

virtual Ptr< Ipv6RoutingProtocol >	GetRoutingProtocol (void) const =0
	Get the routing protocol to be used by this IPv6 stack. More...

virtual void	Insert (Ptr< IpL4Protocol > protocol)=0
	Add a L4 protocol. More...

virtual void	Insert (Ptr< IpL4Protocol > protocol, uint32_t interfaceIndex)=0
	Add a L4 protocol to a specific interface. More...

virtual bool	IsForwarding (uint32_t interface) const =0
	If the specified IPv6 interface has forwarding enabled. More...

virtual bool	IsUp (uint32_t interface) const =0
	If the specified interface index is in "up" state. More...

virtual void	RegisterExtensions ()=0
	Register the IPv6 Extensions. More...

virtual void	RegisterOptions ()=0
	Register the IPv6 Options. More...

virtual void	Remove (Ptr< IpL4Protocol > protocol)=0
	Remove a L4 protocol. More...

virtual void	Remove (Ptr< IpL4Protocol > protocol, uint32_t interfaceIndex)=0
	Remove a L4 protocol from a specific interface. More...

virtual bool	RemoveAddress (uint32_t interface, Ipv6Address address)=0
	Remove the given address on named Ipv6 interface. More...

virtual bool	RemoveAddress (uint32_t interface, uint32_t addressIndex)=0
	Remove an address on specified IPv6 interface. More...

virtual void	Send (Ptr< Packet > packet, Ipv6Address source, Ipv6Address destination, uint8_t protocol, Ptr< Ipv6Route > route)=0
	Higher-level layers call this method to send a packet down the stack to the MAC and PHY layers. More...

virtual void	SetDown (uint32_t interface)=0
	Set the interface into the "down" state. More...

virtual void	SetForwarding (uint32_t interface, bool val)=0
	Set forwarding on specified IPv6 interface. More...

virtual void	SetMetric (uint32_t interface, uint16_t metric)=0
	Set metric on specified Ipv6 interface. More...

virtual void	SetPmtu (Ipv6Address dst, uint32_t pmtu)=0
	Set the Path MTU for the specified IPv6 destination address. More...

virtual void	SetRoutingProtocol (Ptr< Ipv6RoutingProtocol > routingProtocol)=0
	Register a new routing protocol to be used by this IPv6 stack. More...

virtual void	SetUp (uint32_t interface)=0
	Set the interface into the "up" state. More...

virtual Ipv6Address	SourceAddressSelection (uint32_t interface, Ipv6Address dest)=0
	Choose the source address to use with destination address. More...

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

virtual	~Object ()
	Destructor. More...

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

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

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

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this 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...

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

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

bool	IsInitialized (void) 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 (void) const
	Get the reference count of the object. More...

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

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

void	Unref (void) 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 erros. 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 (void)
	Get the type ID. More...

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

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

Static Public Attributes
static const uint32_t	IF_ANY = 0xffffffff
	Any interface magic number. More...

Private Member Functions
virtual bool	GetIpForward (void) const =0
	Get IPv6 forwarding state. More...

virtual bool	GetMtuDiscover (void) const =0
	Get IPv6 MTU discover state. More...

virtual void	SetIpForward (bool forward)=0
	Set IPv6 forwarding state. More...

virtual void	SetMtuDiscover (bool mtuDiscover)=0
	Set IPv6 MTU discover state. More...

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

virtual void	DoDispose (void)
	Destructor implementation. More...

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

virtual void	NotifyNewAggregate (void)
	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 (void)
	Notifier called once the ObjectBase is fully constructed. More...

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

Detailed Description

Access to the IPv6 forwarding table, interfaces, and configuration.

Introspection did not find any typical Config paths.

This class defines the API to manipulate the following aspects of the IPv6 implementation:

set/get an Ipv6RoutingProtocol
register a NetDevice for use by the IPv6 layer (basically, to create IPv6-related state such as addressing and neighbor cache that is associated with a NetDevice)
manipulate the status of the NetDevice from the IPv6 perspective, such as marking it as Up or Down,
adding, deleting, and getting addresses associated to the IPv6 interfaces.
exporting IPv6 configuration attributes

Each NetDevice has conceptually a single IPv6 interface associated with it (the corresponding structure in the Linux IPv6 implementation is struct in_device). Each interface may have one or more IPv6 addresses associated with it. Each IPv6 address may have different subnet mask, scope, etc., so all of this per-address information is stored in an Ipv6InterfaceAddress class (the corresponding structure in Linux is struct in6_ifaddr)

IPv6 attributes such as whether IP forwarding is enabled and disabled are also stored in this class

TO DO: Add API to allow access to the IPv6 neighbor table

See also: Ipv6RoutingProtocol; Ipv6InterfaceAddress

Attributes

IpForward: Globally enable or disable IP forwarding for all current and future IPv6 devices.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
MtuDiscover: If disabled, every interface will have its MTU set to 1280 bytes.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 32 bytes (on a 64-bit architecture).

Definition at line 81 of file ipv6.h.

Constructor & Destructor Documentation

◆ Ipv6()

ns3::Ipv6::Ipv6 ( )

Constructor.

Definition at line 53 of file ipv6.cc.

◆ ~Ipv6()

ns3::Ipv6::~Ipv6 ( )

virtual

Destructor.

Definition at line 57 of file ipv6.cc.

Member Function Documentation

◆ AddAddress()

virtual bool ns3::Ipv6::AddAddress	(	uint32_t	interface,
		Ipv6InterfaceAddress	address,
		bool	addOnLinkRoute = `true`
	)

pure virtual

Add an address on the specified IPv6 interface.

Parameters

interface	Interface number of an IPv6 interface
address	Ipv6InterfaceAddress address to associate with the underlying IPv6 interface
addOnLinkRoute	add on-link route to the network (default true)

Returns: true if the operation succeeded

interface	Interface number of an IPv6 interface
addressIndex	index of Ipv6InterfaceAddress

address	The IP address assigned to the interface of interest.
mask	The IP prefix to use in the mask

protocolNumber	protocol number
interfaceIndex	interface index, -1 means "any" interface.

protocol	L4 protocol to remove.
interfaceIndex	interface index.

packet	packet to send
source	source address of packet
destination	address of packet
protocol	number of packet
route	route to take

interface	Interface number of IPv6 interface
val	Value to set the forwarding flag

interface	The interface number of an IPv6 interface
metric	routing metric (cost) associated to the underlying IPv6 interface

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Attributes

Constructor & Destructor Documentation

◆ Ipv6()

◆ ~Ipv6()

Member Function Documentation

◆ AddAddress()

◆ AddInterface()

◆ GetAddress()

◆ GetInterfaceForAddress()

◆ GetInterfaceForDevice()

◆ GetInterfaceForPrefix()

◆ GetIpForward()

◆ GetMetric()

◆ GetMtu()

◆ GetMtuDiscover()

◆ GetNAddresses()

◆ GetNetDevice()

◆ GetNInterfaces()

◆ GetProtocol() [1/2]

◆ GetProtocol() [2/2]

◆ GetRoutingProtocol()

◆ GetTypeId()

◆ Insert() [1/2]

◆ Insert() [2/2]

◆ IsForwarding()

◆ IsUp()

◆ RegisterExtensions()

◆ RegisterOptions()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ RemoveAddress() [1/2]

◆ RemoveAddress() [2/2]

◆ Send()

◆ SetDown()

◆ SetForwarding()

◆ SetIpForward()

◆ SetMetric()

◆ SetMtuDiscover()

◆ SetPmtu()

◆ SetRoutingProtocol()

◆ SetUp()

◆ SourceAddressSelection()

Member Data Documentation

◆ IF_ANY