IPv6 layer implementation. More...

#include "ipv6-l3-protocol.h"

Inheritance diagram for ns3::Ipv6L3Protocol:

Collaboration diagram for ns3::Ipv6L3Protocol:

Public Types
enum	DropReason { DROP_TTL_EXPIRED = 1 , DROP_NO_ROUTE , DROP_INTERFACE_DOWN , DROP_ROUTE_ERROR , DROP_UNKNOWN_PROTOCOL , DROP_UNKNOWN_OPTION , DROP_MALFORMED_HEADER , DROP_FRAGMENT_TIMEOUT }
	Reason why a packet has been dropped. More...

typedef void(*	DropTracedCallback) (const Ipv6Header &header, Ptr< const Packet > packet, DropReason reason, Ptr< Ipv6 > ipv6, uint32_t interface)
	TracedCallback signature for packet drop events.

typedef void(*	SentTracedCallback) (const Ipv6Header &header, Ptr< const Packet > packet, uint32_t interface)
	TracedCallback signature for packet sent, forwarded or local-delivered events.

typedef void(*	TxRxTracedCallback) (Ptr< const Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)
	TracedCallback signature for packet transmission or reception events.

Public Member Functions
	Ipv6L3Protocol ()
	Constructor.

	Ipv6L3Protocol (const Ipv6L3Protocol &)=delete

	~Ipv6L3Protocol () override
	Destructor.

bool	AddAddress (uint32_t i, Ipv6InterfaceAddress address, bool addOnLinkRoute=true) override
	Add an address on interface.

void	AddAutoconfiguredAddress (uint32_t interface, Ipv6Address network, Ipv6Prefix mask, uint8_t flags, uint32_t validTime, uint32_t preferredTime, Ipv6Address defaultRouter=Ipv6Address::GetZero())
	Add an autoconfigured address with RA information.

uint32_t	AddInterface (Ptr< NetDevice > device) override
	Add IPv6 interface for a device.

void	AddMulticastAddress (Ipv6Address address)
	Adds a multicast address to the list of addresses to pass to local deliver.

void	AddMulticastAddress (Ipv6Address address, uint32_t interface)
	Adds a multicast address to the list of addresses to pass to local deliver.

Ptr< Socket >	CreateRawSocket ()
	Create raw IPv6 socket.

void	DeleteRawSocket (Ptr< Socket > socket)
	Remove raw IPv6 socket.

Ipv6InterfaceAddress	GetAddress (uint32_t interfaceIndex, uint32_t addressIndex) const override
	Get an address.

Ptr< Icmpv6L4Protocol >	GetIcmpv6 () const
	Get ICMPv6 protocol.

Ptr< Ipv6Interface >	GetInterface (uint32_t i) const
	Get an interface.

int32_t	GetInterfaceForAddress (Ipv6Address addr) const override
	Get interface index which has specified IPv6 address.

int32_t	GetInterfaceForDevice (Ptr< const NetDevice > device) const override
	Get interface index which is on a specified net device.

int32_t	GetInterfaceForPrefix (Ipv6Address addr, Ipv6Prefix mask) const override
	Get interface index which match specified address/prefix.

uint16_t	GetMetric (uint32_t i) const override
	Get metric for an interface.

uint16_t	GetMtu (uint32_t i) const override
	Get MTU for an interface.

uint32_t	GetNAddresses (uint32_t interface) const override
	Get number of address for an interface.

Ptr< NetDevice >	GetNetDevice (uint32_t i) override
	Get device by index.

uint32_t	GetNInterfaces () const override
	Get current number of interface on this stack.

Ptr< IpL4Protocol >	GetProtocol (int protocolNumber) const override
	Get L4 protocol by protocol number.

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

Ptr< Ipv6RoutingProtocol >	GetRoutingProtocol () const override
	Get current routing protocol used.

void	Insert (Ptr< IpL4Protocol > protocol) override
	Add a L4 protocol.

void	Insert (Ptr< IpL4Protocol > protocol, uint32_t interfaceIndex) override
	Add a L4 protocol to a specific interface.

bool	IsForwarding (uint32_t i) const override
	Is interface allows forwarding ?

bool	IsRegisteredMulticastAddress (Ipv6Address address) const
	Checks if the address has been registered.

bool	IsRegisteredMulticastAddress (Ipv6Address address, uint32_t interface) const
	Checks if the address has been registered for a specific interface.

bool	IsUp (uint32_t i) const override
	Is specified interface up ?

Ipv6L3Protocol &	operator= (const Ipv6L3Protocol &)=delete

bool	ReachabilityHint (uint32_t ipInterfaceIndex, Ipv6Address address)
	Provides reachability hint for Neighbor Cache Entries from L4-L7 protocols.

void	Receive (Ptr< NetDevice > device, Ptr< const Packet > p, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType)
	Receive method when a packet arrive in the stack.

void	RegisterExtensions () override
	Register the IPv6 Extensions.

void	RegisterOptions () override
	Register the IPv6 Options.

void	Remove (Ptr< IpL4Protocol > protocol) override
	Remove a L4 protocol.

void	Remove (Ptr< IpL4Protocol > protocol, uint32_t interfaceIndex) override
	Remove a L4 protocol from a specific interface.

bool	RemoveAddress (uint32_t interfaceIndex, Ipv6Address address) override
	Remove a specified Ipv6 address from an interface.

bool	RemoveAddress (uint32_t interfaceIndex, uint32_t addressIndex) override
	Remove an address from an interface.

void	RemoveAutoconfiguredAddress (uint32_t interface, Ipv6Address network, Ipv6Prefix mask, Ipv6Address defaultRouter)
	Remove an autoconfigured address.

void	RemoveMulticastAddress (Ipv6Address address)
	Removes a multicast address from the list of addresses to pass to local deliver.

void	RemoveMulticastAddress (Ipv6Address address, uint32_t interface)
	Removes a multicast address from the list of addresses to pass to local deliver.

virtual void	ReportDrop (Ipv6Header ipHeader, Ptr< Packet > p, DropReason dropReason)
	Report a packet drop.

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

void	SetDefaultTclass (uint8_t tclass)
	Set the default TCLASS.

void	SetDefaultTtl (uint8_t ttl)
	Set the default TTL.

void	SetDown (uint32_t i) override
	set an interface down.

void	SetForwarding (uint32_t i, bool val) override
	Enable or disable forwarding on interface.

void	SetMetric (uint32_t i, uint16_t metric) override
	Set metric for an interface.

void	SetNode (Ptr< Node > node)
	Set node associated with this stack.

void	SetPmtu (Ipv6Address dst, uint32_t pmtu) override
	Set the Path MTU for the specified IPv6 destination address.

void	SetRoutingProtocol (Ptr< Ipv6RoutingProtocol > routingProtocol) override
	Set routing protocol for this stack.

void	SetUp (uint32_t i) override
	Set an interface up.

Ipv6Address	SourceAddressSelection (uint32_t interface, Ipv6Address dest) override
	Choose the source address to use with destination address.

Public Member Functions inherited from ns3::Ipv6
	Ipv6 ()
	Constructor.

	~Ipv6 () override
	Destructor.

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

	~Object () override
	Destructor.

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

void	Dispose ()
	Dispose of this Object.

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

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

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

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

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

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

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

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

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

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

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

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

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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

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

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

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

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

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

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID of this class.

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

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

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

Static Public Attributes
static const uint16_t	PROT_NUMBER = 0x86DD
	The protocol number for IPv6 (0x86DD).

Static Public Attributes inherited from ns3::Ipv6
static const uint32_t	IF_ANY = 0xffffffff
	Any interface magic number.

Protected Member Functions
void	DoDispose () override
	Dispose object.

void	NotifyNewAggregate () override
	Notify other components connected to the node that a new stack member is now connected.

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

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

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

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

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

Private Types
typedef std::list< Ptr< Ipv6AutoconfiguredPrefix > >	Ipv6AutoconfiguredPrefixList
	Container of the IPv6 Autoconfigured addresses.

typedef std::list< Ptr< Ipv6AutoconfiguredPrefix > >::iterator	Ipv6AutoconfiguredPrefixListI
	Iterator of the container of the IPv6 Autoconfigured addresses.

typedef std::vector< Ptr< Ipv6Interface > >	Ipv6InterfaceList
	Container of the IPv6 Interfaces.

typedef std::map< Ptr< const NetDevice >, uint32_t >	Ipv6InterfaceReverseContainer
	Container of NetDevices registered to IPv6 and their interface indexes.

typedef std::map< Ipv6RegisteredMulticastAddressKey_t, uint32_t >	Ipv6RegisteredMulticastAddress_t
	Container of the IPv6 multicast addresses.

typedef std::map< Ipv6RegisteredMulticastAddressKey_t, uint32_t >::const_iterator	Ipv6RegisteredMulticastAddressCIter_t
	Container Const Iterator of the IPv6 multicast addresses.

typedef std::map< Ipv6RegisteredMulticastAddressKey_t, uint32_t >::iterator	Ipv6RegisteredMulticastAddressIter_t
	Container Iterator of the IPv6 multicast addresses.

typedef std::pair< Ipv6Address, uint64_t >	Ipv6RegisteredMulticastAddressKey_t
	IPv6 multicast addresses / interface key.

typedef std::map< Ipv6Address, uint32_t >	Ipv6RegisteredMulticastAddressNoInterface_t
	Container of the IPv6 multicast addresses.

typedef std::map< Ipv6Address, uint32_t >::const_iterator	Ipv6RegisteredMulticastAddressNoInterfaceCIter_t
	Container Const Iterator of the IPv6 multicast addresses.

typedef std::map< Ipv6Address, uint32_t >::iterator	Ipv6RegisteredMulticastAddressNoInterfaceIter_t
	Container Iterator of the IPv6 multicast addresses.

typedef std::map< L4ListKey_t, Ptr< IpL4Protocol > >	L4List_t
	Container of the IPv6 L4 instances.

typedef std::pair< int, int32_t >	L4ListKey_t
	Container of the IPv6 L4 keys: protocol number, interface index.

typedef std::list< Ptr< Ipv6RawSocketImpl > >	SocketList
	Container of the IPv6 Raw Sockets.

Private Member Functions
uint32_t	AddIpv6Interface (Ptr< Ipv6Interface > interface)
	Add an IPv6 interface to the stack.

Ipv6Header	BuildHeader (Ipv6Address src, Ipv6Address dst, uint8_t protocol, uint16_t payloadSize, uint8_t hopLimit, uint8_t tclass)
	Construct an IPv6 header.

void	CallTxTrace (const Ipv6Header &ipHeader, Ptr< Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)
	Make a copy of the packet, add the header and invoke the TX trace callback.

bool	GetIpForward () const override
	Get IPv6 forwarding state.

bool	GetMtuDiscover () const override
	Get IPv6 MTU discover state.

virtual bool	GetSendIcmpv6Redirect () const
	Get the ICMPv6 Redirect sending state.

bool	GetStrongEndSystemModel () const override
	Get the Strong End System Model status.

void	IpForward (Ptr< const NetDevice > idev, Ptr< Ipv6Route > rtentry, Ptr< const Packet > p, const Ipv6Header &header)
	Forward a packet.

void	IpMulticastForward (Ptr< const NetDevice > idev, Ptr< Ipv6MulticastRoute > mrtentry, Ptr< const Packet > p, const Ipv6Header &header)
	Forward a multicast packet.

void	LocalDeliver (Ptr< const Packet > p, const Ipv6Header &ip, uint32_t iif)
	Deliver a packet.

void	RouteInputError (Ptr< const Packet > p, const Ipv6Header &ipHeader, Socket::SocketErrno sockErrno)
	Fallback when no route is found.

void	SendRealOut (Ptr< Ipv6Route > route, Ptr< Packet > packet, const Ipv6Header &ipHeader)
	Send packet with route.

void	SetIpForward (bool forward) override
	Set IPv6 forwarding state.

void	SetMtuDiscover (bool mtuDiscover) override
	Set IPv6 MTU discover state.

virtual void	SetSendIcmpv6Redirect (bool sendIcmpv6Redirect)
	Set the ICMPv6 Redirect sending state.

void	SetStrongEndSystemModel (bool model) override
	Set or unset the Strong End System Model.

void	SetupLoopback ()
	Setup loopback interface.

Private Attributes
uint8_t	m_defaultTclass
	Default TCLASS for outgoing packets.

uint8_t	m_defaultTtl
	Default TTL for outgoing packets.

TracedCallback< const Ipv6Header &, Ptr< const Packet >, DropReason, Ptr< Ipv6 >, uint32_t >	m_dropTrace
	Callback to trace drop packets.

Ipv6RoutingProtocol::ErrorCallback	m_ecb
	Error callback.

Ipv6InterfaceList	m_interfaces
	List of IPv6 interfaces.

bool	m_ipForward
	Forwarding packets (i.e.

Ipv6RoutingProtocol::LocalDeliverCallback	m_lcb
	Local delivery callback.

TracedCallback< const Ipv6Header &, Ptr< const Packet >, uint32_t >	m_localDeliverTrace
	Trace of locally delivered packets.

Ipv6RoutingProtocol::MulticastForwardCallback	m_mcb
	Multicast forward callback.

bool	m_mtuDiscover
	MTU Discover (i.e.

Ipv6RegisteredMulticastAddress_t	m_multicastAddresses
	List of multicast IP addresses of interest, divided per interface.

Ipv6RegisteredMulticastAddressNoInterface_t	m_multicastAddressesNoInterface
	List of multicast IP addresses of interest for all the interfaces.

uint32_t	m_nInterfaces
	Number of IPv6 interfaces managed by the stack.

Ptr< Node >	m_node
	Node attached to stack.

Ptr< Ipv6PmtuCache >	m_pmtuCache
	Path MTU Cache.

Ipv6AutoconfiguredPrefixList	m_prefixes
	List of IPv6 prefix received from RA.

L4List_t	m_protocols
	List of transport protocol.

Ipv6InterfaceReverseContainer	m_reverseInterfacesContainer
	Container of NetDevice / Interface index associations.

Ptr< Ipv6RoutingProtocol >	m_routingProtocol
	Routing protocol.

TracedCallback< Ptr< const Packet >, Ptr< Ipv6 >, uint32_t >	m_rxTrace
	Callback to trace RX (reception) packets.

bool	m_sendIcmpv6Redirect
	Allow ICMPv6 Redirect sending state.

TracedCallback< const Ipv6Header &, Ptr< const Packet >, uint32_t >	m_sendOutgoingTrace
	Trace of sent packets.

SocketList	m_sockets
	List of IPv6 raw sockets.

bool	m_strongEndSystemModel
	Rejects packets directed to an interface with wrong address (RFC 1222).

TracedCallback< Ptr< const Packet >, Ptr< Ipv6 >, uint32_t >	m_txTrace
	Callback to trace TX (transmission) packets.

Ipv6RoutingProtocol::UnicastForwardCallback	m_ucb
	Unicast forward callback.

TracedCallback< const Ipv6Header &, Ptr< const Packet >, uint32_t >	m_unicastForwardTrace
	Trace of unicast forwarded packets.

Friends
class	::Ipv6L3ProtocolTestCase
	Ipv6L3ProtocolTestCase test case.

Related Functions
(Note that these are not member functions.)
class	Ipv6ExtensionLooseRouting
	Ipv6ExtensionLooseRouting.

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.

Detailed Description

IPv6 layer implementation.

This class contains two distinct groups of trace sources. The trace sources 'Rx' and 'Tx' are called, respectively, immediately after receiving from the NetDevice and immediately before sending to a NetDevice for transmitting a packet. These are low level trace sources that include the Ipv6Header already serialized into the packet. In contrast, the Drop, SendOutgoing, UnicastForward, and LocalDeliver trace sources are slightly higher-level and pass around the Ipv6Header as an explicit parameter and not as part of the packet.

Config Paths

ns3::Ipv6L3Protocol is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/$ns3::Ipv6L3Protocol"

Attributes

DefaultTclass: The TCLASS value set by default on all outgoing packets generated on this node.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: constructwriteread
DefaultTtl: The TTL value set by default on all outgoing packets generated on this node.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 64
- Flags: constructwriteread
InterfaceList: The set of IPv6 interfaces associated to this IPv6 stack.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::Ipv6Interface>
- Flags: read
SendIcmpv6Redirect: Send the ICMPv6 Redirect when appropriate.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread

Attributes defined in parent class ns3::Ipv6

IpForward: Globally enable or disable IP forwarding for all current and future IPv6 devices.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: constructwriteread
MtuDiscover: If disabled, every interface will have its MTU set to 1280 bytes.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread
StrongEndSystemModel: Reject packets for an address not configured on the interface they're coming from (RFC1122, section 3.3.4.2).
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread

TraceSources

Drop: Drop IPv6 packet
Callback signature: ns3::Ipv6L3Protocol::DropTracedCallback
LocalDeliver: An IPv6 packet was received by/for this node, and it is being forward up the stack
Callback signature: ns3::Ipv6L3Protocol::SentTracedCallback
Rx: Receive IPv6 packet from incoming interface.
Callback signature: ns3::Ipv6L3Protocol::TxRxTracedCallback
SendOutgoing: A newly-generated packet by this node is about to be queued for transmission
Callback signature: ns3::Ipv6L3Protocol::SentTracedCallback
Tx: Send IPv6 packet to outgoing interface.
Callback signature: ns3::Ipv6L3Protocol::TxRxTracedCallback
UnicastForward: A unicast IPv6 packet was received by this node and is being forwarded to another node
Callback signature: ns3::Ipv6L3Protocol::SentTracedCallback

Size of this type is 480 bytes (on a 64-bit architecture).

Definition at line 63 of file ipv6-l3-protocol.h.

Member Typedef Documentation

◆ DropTracedCallback

typedef void(* ns3::Ipv6L3Protocol::DropTracedCallback) (const Ipv6Header &header, Ptr< const Packet > packet, DropReason reason, Ptr< Ipv6 > ipv6, uint32_t interface)

TracedCallback signature for packet drop events.

Parameters

[in]	header	the Ipv6Header.
[in]	packet	the packet.
[in]	reason	the reason the packet was dropped.
[in]	ipv6	the Ipv6 protocol
[in]	interface	the IP-level interface index

Deprecated:: The non-const Ptr<Ipv6> argument is deprecated and will be changed to Ptr<const Ipv6> in a future release.

Definition at line 423 of file ipv6-l3-protocol.h.

◆ Ipv6AutoconfiguredPrefixList

typedef std::list<Ptr<Ipv6AutoconfiguredPrefix> > ns3::Ipv6L3Protocol::Ipv6AutoconfiguredPrefixList

private

Container of the IPv6 Autoconfigured addresses.

Definition at line 544 of file ipv6-l3-protocol.h.

◆ Ipv6AutoconfiguredPrefixListI

typedef std::list<Ptr<Ipv6AutoconfiguredPrefix>>::iterator ns3::Ipv6L3Protocol::Ipv6AutoconfiguredPrefixListI

private

Iterator of the container of the IPv6 Autoconfigured addresses.

Definition at line 549 of file ipv6-l3-protocol.h.

◆ Ipv6InterfaceList

typedef std::vector<Ptr<Ipv6Interface> > ns3::Ipv6L3Protocol::Ipv6InterfaceList

private

Container of the IPv6 Interfaces.

Definition at line 519 of file ipv6-l3-protocol.h.

◆ Ipv6InterfaceReverseContainer

typedef std::map<Ptr<const NetDevice>, uint32_t> ns3::Ipv6L3Protocol::Ipv6InterfaceReverseContainer

private

Container of NetDevices registered to IPv6 and their interface indexes.

Definition at line 524 of file ipv6-l3-protocol.h.

◆ Ipv6RegisteredMulticastAddress_t

typedef std::map<Ipv6RegisteredMulticastAddressKey_t, uint32_t> ns3::Ipv6L3Protocol::Ipv6RegisteredMulticastAddress_t

private

Container of the IPv6 multicast addresses.

Definition at line 797 of file ipv6-l3-protocol.h.

◆ Ipv6RegisteredMulticastAddressCIter_t

typedef std::map<Ipv6RegisteredMulticastAddressKey_t,uint32_t>::const_iterator ns3::Ipv6L3Protocol::Ipv6RegisteredMulticastAddressCIter_t

private

Container Const Iterator of the IPv6 multicast addresses.

Definition at line 809 of file ipv6-l3-protocol.h.

◆ Ipv6RegisteredMulticastAddressIter_t

typedef std::map<Ipv6RegisteredMulticastAddressKey_t,uint32_t>::iterator ns3::Ipv6L3Protocol::Ipv6RegisteredMulticastAddressIter_t

private

Container Iterator of the IPv6 multicast addresses.

Definition at line 803 of file ipv6-l3-protocol.h.

◆ Ipv6RegisteredMulticastAddressKey_t

typedef std::pair<Ipv6Address, uint64_t> ns3::Ipv6L3Protocol::Ipv6RegisteredMulticastAddressKey_t

private

IPv6 multicast addresses / interface key.

Definition at line 791 of file ipv6-l3-protocol.h.

◆ Ipv6RegisteredMulticastAddressNoInterface_t

typedef std::map<Ipv6Address, uint32_t> ns3::Ipv6L3Protocol::Ipv6RegisteredMulticastAddressNoInterface_t

private

Container of the IPv6 multicast addresses.

Definition at line 814 of file ipv6-l3-protocol.h.

◆ Ipv6RegisteredMulticastAddressNoInterfaceCIter_t

typedef std::map<Ipv6Address,uint32_t>::const_iterator ns3::Ipv6L3Protocol::Ipv6RegisteredMulticastAddressNoInterfaceCIter_t

private

Container Const Iterator of the IPv6 multicast addresses.

Definition at line 826 of file ipv6-l3-protocol.h.

◆ Ipv6RegisteredMulticastAddressNoInterfaceIter_t

typedef std::map<Ipv6Address,uint32_t>::iterator ns3::Ipv6L3Protocol::Ipv6RegisteredMulticastAddressNoInterfaceIter_t

private

Container Iterator of the IPv6 multicast addresses.

Definition at line 820 of file ipv6-l3-protocol.h.

◆ L4List_t

typedef std::map<L4ListKey_t, Ptr<IpL4Protocol> > ns3::Ipv6L3Protocol::L4List_t

private

Container of the IPv6 L4 instances.

Definition at line 539 of file ipv6-l3-protocol.h.

◆ L4ListKey_t

typedef std::pair<int, int32_t> ns3::Ipv6L3Protocol::L4ListKey_t

private

Container of the IPv6 L4 keys: protocol number, interface index.

Definition at line 534 of file ipv6-l3-protocol.h.

◆ SentTracedCallback

typedef void(* ns3::Ipv6L3Protocol::SentTracedCallback) (const Ipv6Header &header, Ptr< const Packet > packet, uint32_t interface)

TracedCallback signature for packet sent, forwarded or local-delivered events.

Parameters

[in]	header	the Ipv6Header.
[in]	packet	the packet.
[in]	interface	the IP-level interface index

Definition at line 395 of file ipv6-l3-protocol.h.

◆ SocketList

typedef std::list<Ptr<Ipv6RawSocketImpl> > ns3::Ipv6L3Protocol::SocketList

private

Container of the IPv6 Raw Sockets.

Definition at line 529 of file ipv6-l3-protocol.h.

◆ TxRxTracedCallback

typedef void(* ns3::Ipv6L3Protocol::TxRxTracedCallback) (Ptr< const Packet > packet, Ptr< Ipv6 > ipv6, uint32_t interface)

TracedCallback signature for packet transmission or reception events.

Parameters

[in]	packet	the packet.
[in]	ipv6	the Ipv6 protocol
[in]	interface	the IP-level interface index

Deprecated:: The non-const Ptr<Ipv6> argument is deprecated and will be changed to Ptr<const Ipv6> in a future release.

Definition at line 408 of file ipv6-l3-protocol.h.

Member Enumeration Documentation

◆ DropReason

enum ns3::Ipv6L3Protocol::DropReason

Reason why a packet has been dropped.

Enumerator
DROP_TTL_EXPIRED	Packet TTL has expired.
DROP_NO_ROUTE	No route to host.
DROP_INTERFACE_DOWN	Interface is down so can not send packet.
DROP_ROUTE_ERROR	Route error.
DROP_UNKNOWN_PROTOCOL	Unknown L4 protocol.
DROP_UNKNOWN_OPTION	Unknown option.
DROP_MALFORMED_HEADER	Malformed header.
DROP_FRAGMENT_TIMEOUT	Fragment timeout.

Definition at line 81 of file ipv6-l3-protocol.h.

Constructor & Destructor Documentation

◆ Ipv6L3Protocol() [1/2]

ns3::Ipv6L3Protocol::Ipv6L3Protocol ( )

Constructor.

Definition at line 122 of file ipv6-l3-protocol.cc.

References ns3::Object::AggregateObject(), IpForward(), IpMulticastForward(), LocalDeliver(), m_ecb, m_lcb, m_mcb, m_pmtuCache, m_ucb, ns3::MakeCallback(), NS_LOG_FUNCTION, and RouteInputError().

Here is the call graph for this function:

◆ ~Ipv6L3Protocol()

ns3::Ipv6L3Protocol::~Ipv6L3Protocol ( )

override

Destructor.

Definition at line 136 of file ipv6-l3-protocol.cc.

References NS_LOG_FUNCTION.

◆ Ipv6L3Protocol() [2/2]

ns3::Ipv6L3Protocol::Ipv6L3Protocol ( const Ipv6L3Protocol & )

delete

Member Function Documentation

◆ AddAddress()

bool ns3::Ipv6L3Protocol::AddAddress	(	uint32_t	i,
		Ipv6InterfaceAddress	address,
		bool	addOnLinkRoute = `true`
	)

overridevirtual

Add an address on interface.

Parameters

i	interface index
address	address to add
addOnLinkRoute	add on-link route to the network (default true)

Returns: true if the operation succeeded

Implements ns3::Ipv6.

Definition at line 426 of file ipv6-l3-protocol.cc.

References NS_LOG_FUNCTION.

Referenced by AddAutoconfiguredAddress().

Here is the caller graph for this function:

◆ AddAutoconfiguredAddress()

void ns3::Ipv6L3Protocol::AddAutoconfiguredAddress	(	uint32_t	interface,
		Ipv6Address	network,
		Ipv6Prefix	mask,
		uint8_t	flags,
		uint32_t	validTime,
		uint32_t	preferredTime,
		Ipv6Address	defaultRouter = `Ipv6Address::GetZero()`
	)

Add an autoconfigured address with RA information.

Parameters

interface	interface index
network	network prefix
mask	network mask
flags	flags of the prefix information option (home agent, ...)
validTime	valid time of the prefix
preferredTime	preferred time of the prefix
defaultRouter	default router address

Definition at line 312 of file ipv6-l3-protocol.cc.

References AddAddress(), ns3::Icmpv6OptionPrefixInformation::AUTADDRCONF, ns3::Ipv6Address::GetAny(), ns3::Ipv6Interface::GetDevice(), GetInterface(), GetRoutingProtocol(), ns3::Ipv6Address::IsAny(), m_node, m_prefixes, m_routingProtocol, ns3::Ipv6Address::MakeAutoconfiguredAddress(), NS_LOG_FUNCTION, NS_LOG_INFO, and ns3::Icmpv6OptionPrefixInformation::ONLINK.

Here is the call graph for this function:

◆ AddInterface()

uint32_t ns3::Ipv6L3Protocol::AddInterface ( Ptr< NetDevice > device )

overridevirtual

Add IPv6 interface for a device.

Parameters

device net device

Returns: interface index

Implements ns3::Ipv6.

Definition at line 198 of file ipv6-l3-protocol.cc.

References AddIpv6Interface(), ns3::CreateObject(), ns3::Object::GetObject(), m_ipForward, m_node, ns3::MakeCallback(), NS_ASSERT, NS_LOG_FUNCTION, PROT_NUMBER, Receive(), ns3::TrafficControlLayer::Receive(), and ns3::Node::RegisterProtocolHandler().

Here is the call graph for this function:

◆ AddIpv6Interface()

uint32_t ns3::Ipv6L3Protocol::AddIpv6Interface ( Ptr< Ipv6Interface > interface )

private

Add an IPv6 interface to the stack.

Parameters

interface interface to add

Returns: index of newly added interface

Definition at line 223 of file ipv6-l3-protocol.cc.

References m_interfaces, m_nInterfaces, m_reverseInterfacesContainer, and NS_LOG_FUNCTION.

Referenced by AddInterface(), and SetupLoopback().

Here is the caller graph for this function:

◆ AddMulticastAddress() [1/2]

void ns3::Ipv6L3Protocol::AddMulticastAddress ( Ipv6Address address )

Adds a multicast address to the list of addresses to pass to local deliver.

Parameters

address the address.

Definition at line 1712 of file ipv6-l3-protocol.cc.

References m_multicastAddressesNoInterface, NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ AddMulticastAddress() [2/2]

void ns3::Ipv6L3Protocol::AddMulticastAddress	(	Ipv6Address	address,
		uint32_t	interface
	)

Adds a multicast address to the list of addresses to pass to local deliver.

Parameters

address	the address.
interface	the incoming interface.

Definition at line 1697 of file ipv6-l3-protocol.cc.

References m_multicastAddresses, NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ BuildHeader()

Ipv6Header ns3::Ipv6L3Protocol::BuildHeader	(	Ipv6Address	src,
		Ipv6Address	dst,
		uint8_t	protocol,
		uint16_t	payloadSize,
		uint8_t	hopLimit,
		uint8_t	tclass
	)

private

Construct an IPv6 header.

Parameters

src	source IPv6 address
dst	destination IPv6 address
protocol	L4 protocol
payloadSize	payload size
hopLimit	Hop limit
tclass	Tclass

Returns: newly created IPv6 header

Definition at line 1603 of file ipv6-l3-protocol.cc.

References NS_LOG_FUNCTION, ns3::Ipv6Header::SetDestination(), ns3::Ipv6Header::SetHopLimit(), ns3::Ipv6Header::SetNextHeader(), ns3::Ipv6Header::SetPayloadLength(), ns3::Ipv6Header::SetSource(), and ns3::Ipv6Header::SetTrafficClass().

Referenced by Send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CallTxTrace()

void ns3::Ipv6L3Protocol::CallTxTrace	(	const Ipv6Header &	ipHeader,
		Ptr< Packet >	packet,
		Ptr< Ipv6 >	ipv6,
		uint32_t	interface
	)

private

Make a copy of the packet, add the header and invoke the TX trace callback.

Parameters

ipHeader	the IP header that will be added to the packet
packet	the packet
ipv6	the Ipv6 protocol
interface	the IP-level interface index

Note: If the TracedCallback API ever is extended, we could consider to check for connected functions before adding the header

Definition at line 1174 of file ipv6-l3-protocol.cc.

References m_txTrace.

◆ CreateRawSocket()

Ptr< Socket > ns3::Ipv6L3Protocol::CreateRawSocket ( )

Create raw IPv6 socket.

Returns: newly raw socket

Definition at line 860 of file ipv6-l3-protocol.cc.

References m_node, m_sockets, and NS_LOG_FUNCTION.

◆ DeleteRawSocket()

void ns3::Ipv6L3Protocol::DeleteRawSocket ( Ptr< Socket > socket )

Remove raw IPv6 socket.

Parameters

socket socket to remove

Definition at line 870 of file ipv6-l3-protocol.cc.

References m_sockets, and NS_LOG_FUNCTION.

◆ DoDispose()

void ns3::Ipv6L3Protocol::DoDispose ( )

overrideprotectedvirtual

Dispose object.

Reimplemented from ns3::Object.

Definition at line 142 of file ipv6-l3-protocol.cc.

References ns3::Object::DoDispose(), m_interfaces, m_node, m_pmtuCache, m_prefixes, m_protocols, m_reverseInterfacesContainer, m_routingProtocol, m_sockets, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetAddress()

Ipv6InterfaceAddress ns3::Ipv6L3Protocol::GetAddress	(	uint32_t	interfaceIndex,
		uint32_t	addressIndex
	)		const

overridevirtual

Get an address.

Parameters

interfaceIndex	interface index
addressIndex	address index on the interface

Returns: Ipv6InterfaceAddress or assert if not found

Implements ns3::Ipv6.

Definition at line 458 of file ipv6-l3-protocol.cc.

Referenced by UanExperiment::SendPackets(), and SourceAddressSelection().

Here is the caller graph for this function:

◆ GetIcmpv6()

Ptr< Icmpv6L4Protocol > ns3::Ipv6L3Protocol::GetIcmpv6 ( ) const

Get ICMPv6 protocol.

Returns: Icmpv6L4Protocol pointer

Definition at line 885 of file ipv6-l3-protocol.cc.

References GetProtocol(), and ns3::Icmpv6L4Protocol::GetStaticProtocolNumber().

Referenced by IpForward(), LocalDeliver(), and RouteInputError().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetInterface()

Ptr< Ipv6Interface > ns3::Ipv6L3Protocol::GetInterface ( uint32_t i ) const

Get an interface.

Parameters

i	interface index

Returns: IPv6 interface pointer

Definition at line 235 of file ipv6-l3-protocol.cc.

References m_interfaces.

Referenced by AddAutoconfiguredAddress(), GetNetDevice(), IpForward(), LocalDeliver(), and RemoveAutoconfiguredAddress().

Here is the caller graph for this function:

◆ GetInterfaceForAddress()

int32_t ns3::Ipv6L3Protocol::GetInterfaceForAddress ( Ipv6Address addr ) const

overridevirtual

Get interface index which has specified IPv6 address.

Parameters

addr	IPv6 address

Returns: interface index or -1 if not found

Implements ns3::Ipv6.

Definition at line 251 of file ipv6-l3-protocol.cc.

References m_interfaces.

Referenced by Send().

Here is the caller graph for this function:

◆ GetInterfaceForDevice()

int32_t ns3::Ipv6L3Protocol::GetInterfaceForDevice ( Ptr< const NetDevice > device ) const

overridevirtual

Get interface index which is on a specified net device.

Parameters

device net device

Returns: the interface index

Implements ns3::Ipv6.

Definition at line 300 of file ipv6-l3-protocol.cc.

References m_reverseInterfacesContainer.

Referenced by IpForward(), Receive(), and Send().

Here is the caller graph for this function:

◆ GetInterfaceForPrefix()

int32_t ns3::Ipv6L3Protocol::GetInterfaceForPrefix	(	Ipv6Address	addr,
		Ipv6Prefix	mask
	)		const

overridevirtual

Get interface index which match specified address/prefix.

Parameters

addr	IPv6 address
mask	IPv6 prefix (mask)

Returns: interface index or -1 if not found

Implements ns3::Ipv6.

Definition at line 273 of file ipv6-l3-protocol.cc.

References m_interfaces.

◆ GetIpForward()

bool ns3::Ipv6L3Protocol::GetIpForward ( ) const

overrideprivatevirtual

Get IPv6 forwarding state.

Returns: forwarding state (enabled or not)

Implements ns3::Ipv6.

Definition at line 707 of file ipv6-l3-protocol.cc.

References m_ipForward.

◆ GetMetric()

uint16_t ns3::Ipv6L3Protocol::GetMetric ( uint32_t i ) const

overridevirtual

Get metric for an interface.

Parameters

i index

Returns: metric

Implements ns3::Ipv6.

Definition at line 514 of file ipv6-l3-protocol.cc.

◆ GetMtu()

uint16_t ns3::Ipv6L3Protocol::GetMtu ( uint32_t i ) const

overridevirtual

Get MTU for an interface.

Parameters

i index

Returns: MTU

Implements ns3::Ipv6.

Definition at line 521 of file ipv6-l3-protocol.cc.

References IPV6_MIN_MTU, and m_mtuDiscover.

◆ GetMtuDiscover()

bool ns3::Ipv6L3Protocol::GetMtuDiscover ( ) const

overrideprivatevirtual

Get IPv6 MTU discover state.

Returns: MTU discover state (enabled or not)

Implements ns3::Ipv6.

Definition at line 720 of file ipv6-l3-protocol.cc.

References m_mtuDiscover.

◆ GetNAddresses()

uint32_t ns3::Ipv6L3Protocol::GetNAddresses ( uint32_t interface ) const

overridevirtual

Get number of address for an interface.

Parameters

interface interface index

Returns: number of address

Implements ns3::Ipv6.

Definition at line 451 of file ipv6-l3-protocol.cc.

Referenced by SourceAddressSelection().

Here is the caller graph for this function:

◆ GetNetDevice()

Ptr< NetDevice > ns3::Ipv6L3Protocol::GetNetDevice ( uint32_t i )

overridevirtual

Get device by index.

Parameters

i	device index on this stack

Returns: NetDevice pointer

Implements ns3::Ipv6.

Definition at line 294 of file ipv6-l3-protocol.cc.

References ns3::Ipv6Interface::GetDevice(), and GetInterface().

Referenced by IpMulticastForward(), and Send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNInterfaces()

uint32_t ns3::Ipv6L3Protocol::GetNInterfaces ( ) const

overridevirtual

Get current number of interface on this stack.

Returns: number of interface registered

Implements ns3::Ipv6.

Definition at line 245 of file ipv6-l3-protocol.cc.

References m_nInterfaces.

◆ GetProtocol() [1/2]

Ptr< IpL4Protocol > ns3::Ipv6L3Protocol::GetProtocol ( int protocolNumber ) const

overridevirtual

Get L4 protocol by protocol number.

Parameters

protocolNumber protocol number

Returns: corresponding IpL4Protocol or 0 if not found

Implements ns3::Ipv6.

Definition at line 830 of file ipv6-l3-protocol.cc.

References GetProtocol().

Referenced by GetIcmpv6(), GetProtocol(), and LocalDeliver().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetProtocol() [2/2]

Ptr< IpL4Protocol > ns3::Ipv6L3Protocol::GetProtocol	(	int	protocolNumber,
		int32_t	interfaceIndex
	)		const

overridevirtual

Get L4 protocol by protocol number for the specified interface.

Parameters

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

Returns: corresponding IpL4Protocol or 0 if not found

Implements ns3::Ipv6.

Definition at line 836 of file ipv6-l3-protocol.cc.

References m_protocols.

◆ GetRoutingProtocol()

Ptr< Ipv6RoutingProtocol > ns3::Ipv6L3Protocol::GetRoutingProtocol ( ) const

overridevirtual

Get current routing protocol used.

Returns: routing protocol

Implements ns3::Ipv6.

Definition at line 192 of file ipv6-l3-protocol.cc.

References m_routingProtocol.

Referenced by AddAutoconfiguredAddress(), and RemoveAutoconfiguredAddress().

Here is the caller graph for this function:

◆ GetSendIcmpv6Redirect()

bool ns3::Ipv6L3Protocol::GetSendIcmpv6Redirect ( ) const

privatevirtual

Get the ICMPv6 Redirect sending state.

Returns: ICMPv6 Redirect sending state (enabled or not)

Definition at line 733 of file ipv6-l3-protocol.cc.

References m_sendIcmpv6Redirect.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetStrongEndSystemModel()

bool ns3::Ipv6L3Protocol::GetStrongEndSystemModel ( ) const

overrideprivatevirtual

Get the Strong End System Model status.

RFC1122 term for whether host rejects datagram with a dest. address on another interface

Returns: true for Strong End System Model activated

Implements ns3::Ipv6.

Definition at line 1825 of file ipv6-l3-protocol.cc.

References m_strongEndSystemModel.

◆ GetTypeId()

TypeId ns3::Ipv6L3Protocol::GetTypeId ( )

static

Get the type ID of this class.

Returns: type ID

Definition at line 61 of file ipv6-l3-protocol.cc.

References GetSendIcmpv6Redirect(), m_defaultTclass, m_defaultTtl, m_dropTrace, m_interfaces, m_localDeliverTrace, m_rxTrace, m_sendOutgoingTrace, m_txTrace, m_unicastForwardTrace, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeObjectVectorAccessor(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::TypeId::SetParent(), and SetSendIcmpv6Redirect().

Here is the call graph for this function:

◆ Insert() [1/2]

void ns3::Ipv6L3Protocol::Insert ( Ptr< IpL4Protocol > protocol )

overridevirtual

Add a L4 protocol.

Parameters

protocol L4 protocol

Implements ns3::Ipv6.

Definition at line 767 of file ipv6-l3-protocol.cc.

References m_protocols, NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ Insert() [2/2]

void ns3::Ipv6L3Protocol::Insert	(	Ptr< IpL4Protocol >	protocol,
		uint32_t	interfaceIndex
	)

overridevirtual

Add a L4 protocol to a specific interface.

This may be called multiple times for multiple interfaces for the same protocol. To insert for all interfaces, use the separate Insert (Ptr<IpL4Protocol> protocol) method.

Setting a protocol on a specific interface will overwrite the previously bound protocol.

Parameters

protocol	L4 protocol.
interfaceIndex	interface index.

Implements ns3::Ipv6.

Definition at line 779 of file ipv6-l3-protocol.cc.

References m_protocols, NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ IpForward()

void ns3::Ipv6L3Protocol::IpForward	(	Ptr< const NetDevice >	idev,
		Ptr< Ipv6Route >	rtentry,
		Ptr< const Packet >	p,
		const Ipv6Header &	header
	)

private

Forward a packet.

Parameters

idev	Pointer to ingress network device
rtentry	route
p	packet to forward
header	IPv6 header to add to the packet

Definition at line 1319 of file ipv6-l3-protocol.cc.

References DROP_ROUTE_ERROR, DROP_TTL_EXPIRED, ns3::Ipv6InterfaceAddress::GetAddress(), ns3::Ipv6Header::GetDestination(), ns3::Ipv6Header::GetHopLimit(), GetIcmpv6(), ns3::Node::GetId(), GetInterface(), GetInterfaceForDevice(), ns3::Ipv6Interface::GetLinkLocalAddress(), ns3::Ipv6Header::GetSource(), ns3::Icmpv6Header::ICMPV6_HOPLIMIT, ns3::Ipv6Address::IsAny(), ns3::Ipv6Address::IsDocumentation(), ns3::Ipv6Address::IsLinkLocal(), ns3::Ipv6Address::IsMulticast(), m_dropTrace, m_node, m_sendIcmpv6Redirect, m_unicastForwardTrace, NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, SendRealOut(), and ns3::Ipv6Header::SetHopLimit().

Referenced by Ipv6L3Protocol().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IpMulticastForward()

void ns3::Ipv6L3Protocol::IpMulticastForward	(	Ptr< const NetDevice >	idev,
		Ptr< Ipv6MulticastRoute >	mrtentry,
		Ptr< const Packet >	p,
		const Ipv6Header &	header
	)

private

Forward a multicast packet.

Parameters

idev	Pointer to ingress network device
mrtentry	route
p	packet to forward
header	IPv6 header to add to the packet

Definition at line 1412 of file ipv6-l3-protocol.cc.

References DROP_TTL_EXPIRED, ns3::Ipv6Address::GetAny(), ns3::Ipv6Header::GetDestination(), ns3::Ipv6Header::GetHopLimit(), ns3::Node::GetId(), GetNetDevice(), ns3::Ipv6Header::GetSource(), m_dropTrace, m_node, NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, SendRealOut(), and ns3::Ipv6Header::SetHopLimit().

Referenced by Ipv6L3Protocol().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsForwarding()

bool ns3::Ipv6L3Protocol::IsForwarding ( uint32_t i ) const

overridevirtual

Is interface allows forwarding ?

Parameters

i	interface index

Returns: true if the interface is forwarding

Implements ns3::Ipv6.

Definition at line 631 of file ipv6-l3-protocol.cc.

References NS_LOG_LOGIC.

◆ IsRegisteredMulticastAddress() [1/2]

bool ns3::Ipv6L3Protocol::IsRegisteredMulticastAddress ( Ipv6Address address ) const

Checks if the address has been registered.

Parameters

address the address.

Returns: true if the address is registered.

Definition at line 1761 of file ipv6-l3-protocol.cc.

References m_multicastAddressesNoInterface.

◆ IsRegisteredMulticastAddress() [2/2]

bool ns3::Ipv6L3Protocol::IsRegisteredMulticastAddress	(	Ipv6Address	address,
		uint32_t	interface
	)		const

Checks if the address has been registered for a specific interface.

Parameters

address	the address.
interface	the incoming interface.

Returns: true if the address is registered.

Definition at line 1752 of file ipv6-l3-protocol.cc.

References m_multicastAddresses.

◆ IsUp()

bool ns3::Ipv6L3Protocol::IsUp ( uint32_t i ) const

overridevirtual

Is specified interface up ?

Parameters

i	interface index

Returns: true if the interface is up

Implements ns3::Ipv6.

Definition at line 541 of file ipv6-l3-protocol.cc.

◆ LocalDeliver()

void ns3::Ipv6L3Protocol::LocalDeliver	(	Ptr< const Packet >	p,
		const Ipv6Header &	ip,
		uint32_t	iif
	)

private

Deliver a packet.

Parameters

p	packet delivered
ip	IPv6 header
iif	input interface packet was received

Definition at line 1446 of file ipv6-l3-protocol.cc.

References DROP_UNKNOWN_PROTOCOL, ns3::Ipv6Header::GetDestination(), GetIcmpv6(), GetInterface(), ns3::Ipv6Header::GetNextHeader(), ns3::Object::GetObject(), GetProtocol(), ns3::Ipv6Header::GetSerializedSize(), ns3::Ipv6Header::GetSource(), ns3::Icmpv6Header::ICMPV6_PORT_UNREACHABLE, ns3::Icmpv6Header::ICMPV6_UNKNOWN_NEXT_HEADER, ns3::Ipv6Header::IPV6_EXT_FRAGMENTATION, ns3::Ipv6Header::IPV6_EXT_HOP_BY_HOP, ns3::Ipv6Address::IsMulticast(), m_dropTrace, m_localDeliverTrace, m_node, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, ns3::IpL4Protocol::RX_CSUM_FAILED, ns3::IpL4Protocol::RX_ENDPOINT_CLOSED, ns3::IpL4Protocol::RX_ENDPOINT_UNREACH, ns3::IpL4Protocol::RX_OK, ns3::Ipv6Header::SetNextHeader(), and ns3::Ipv6Header::SetPayloadLength().

Referenced by Ipv6L3Protocol().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NotifyNewAggregate()

void ns3::Ipv6L3Protocol::NotifyNewAggregate ( )

overrideprotectedvirtual

Notify other components connected to the node that a new stack member is now connected.

This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together.

Reimplemented from ns3::Object.

Definition at line 739 of file ipv6-l3-protocol.cc.

References m_node, ns3::Object::NotifyNewAggregate(), NS_LOG_FUNCTION, and SetNode().

Here is the call graph for this function:

◆ operator=()

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

delete

◆ ReachabilityHint()

bool ns3::Ipv6L3Protocol::ReachabilityHint	(	uint32_t	ipInterfaceIndex,
		Ipv6Address	address
	)

Provides reachability hint for Neighbor Cache Entries from L4-L7 protocols.

This function shall be called by L4-L7 protocols when an address is confirmed to be reachable (i.e., at least a packet send and a reply received). The net effect is to extend the NCE reachability time if the NCE is in REACHABLE state, and to mark the NCE as REACHABLE if it is in STALE, PROBE, or DELAY states. NCEs in INCOMPLETE state are not changed.

Note that the IP interface index might not be the same as the NetDevice index. The correct way to check the IP interface index is by using Ipv6::GetInterfaceForDevice ().

Parameters

ipInterfaceIndex	IP interface index
address	reachable address

Returns: true if the NCE has been successfully updated.

Definition at line 1769 of file ipv6-l3-protocol.cc.

References ns3::NdiscCache::Entry::ClearWaitingPacket(), ns3::NdiscCache::Entry::GetMacAddress(), ns3::NdiscCache::Entry::IsAutoGenerated(), ns3::NdiscCache::Entry::IsIncomplete(), ns3::NdiscCache::Entry::IsPermanent(), ns3::NdiscCache::Entry::IsProbe(), ns3::NdiscCache::Entry::IsReachable(), m_interfaces, ns3::NdiscCache::Entry::MarkReachable(), ns3::NdiscCache::Entry::StartReachableTimer(), and ns3::NdiscCache::Entry::UpdateReachableTimer().

Here is the call graph for this function:

◆ Receive()

void ns3::Ipv6L3Protocol::Receive	(	Ptr< NetDevice >	device,
		Ptr< const Packet >	p,
		uint16_t	protocol,
		const Address &	from,
		const Address &	to,
		NetDevice::PacketType	packetType
	)

Receive method when a packet arrive in the stack.

This method removes IPv6 header and forward up to L4 protocol.

Parameters

device	network device
p	the packet
protocol	next header value
from	address of the correspondent
to	address of the destination
packetType	type of the packet

Definition at line 1002 of file ipv6-l3-protocol.cc.

References ns3::Ipv6InterfaceAddress::GetAddress(), ns3::Ipv6Header::GetDestination(), ns3::Node::GetId(), GetInterfaceForDevice(), ns3::Ipv6Header::GetNextHeader(), ns3::Ipv6Header::GetPayloadLength(), ns3::Ipv6Header::GetSource(), ns3::Ipv6Address::IsAllNodesMulticast(), ns3::Ipv6Address::IsAllRoutersMulticast(), ns3::Ipv6Address::IsMulticast(), m_node, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, and ns3::NdiscCache::Entry::UpdateReachableTimer().

Referenced by AddInterface(), and SetupLoopback().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterExtensions()

void ns3::Ipv6L3Protocol::RegisterExtensions ( )

overridevirtual

Register the IPv6 Extensions.

Does nothing if the Extensions have been already registered.

Implements ns3::Ipv6.

Definition at line 1624 of file ipv6-l3-protocol.cc.

References ns3::Object::AggregateObject(), ns3::Object::GetObject(), and m_node.

Here is the call graph for this function:

◆ RegisterOptions()

void ns3::Ipv6L3Protocol::RegisterOptions ( )

overridevirtual

Register the IPv6 Options.

Does nothing if the Options have been already registered.

Implements ns3::Ipv6.

Definition at line 1664 of file ipv6-l3-protocol.cc.

References ns3::Object::AggregateObject(), ns3::Object::GetObject(), and m_node.

Here is the call graph for this function:

◆ Remove() [1/2]

void ns3::Ipv6L3Protocol::Remove ( Ptr< IpL4Protocol > protocol )

overridevirtual

Remove a L4 protocol.

Parameters

protocol L4 protocol to remove.

Implements ns3::Ipv6.

Definition at line 793 of file ipv6-l3-protocol.cc.

References m_protocols, NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ Remove() [2/2]

void ns3::Ipv6L3Protocol::Remove	(	Ptr< IpL4Protocol >	protocol,
		uint32_t	interfaceIndex
	)

overridevirtual

Remove a L4 protocol from a specific interface.

Parameters

protocol	L4 protocol to remove.
interfaceIndex	interface index.

Implements ns3::Ipv6.

Definition at line 811 of file ipv6-l3-protocol.cc.

References m_protocols, NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ RemoveAddress() [1/2]

bool ns3::Ipv6L3Protocol::RemoveAddress	(	uint32_t	interfaceIndex,
		Ipv6Address	address
	)

overridevirtual

Remove a specified Ipv6 address from an interface.

Parameters

interfaceIndex	interface index
address	Ipv6Address to be removed from the interface

Returns: true if the operation succeeded

Implements ns3::Ipv6.

Definition at line 483 of file ipv6-l3-protocol.cc.

References ns3::Ipv6Address::GetLoopback(), NS_LOG_FUNCTION, and NS_LOG_WARN.

Here is the call graph for this function:

◆ RemoveAddress() [2/2]

bool ns3::Ipv6L3Protocol::RemoveAddress	(	uint32_t	interfaceIndex,
		uint32_t	addressIndex
	)

overridevirtual

Remove an address from an interface.

Parameters

interfaceIndex	interface index
addressIndex	address index on the interface

Returns: true if the operation succeeded

Implements ns3::Ipv6.

Definition at line 465 of file ipv6-l3-protocol.cc.

References NS_LOG_FUNCTION.

Referenced by RemoveAutoconfiguredAddress().

Here is the caller graph for this function:

◆ RemoveAutoconfiguredAddress()

void ns3::Ipv6L3Protocol::RemoveAutoconfiguredAddress	(	uint32_t	interface,
		Ipv6Address	network,
		Ipv6Prefix	mask,
		Ipv6Address	defaultRouter
	)

Remove an autoconfigured address.

Typically it is used when an autoconfigured address expires.

Parameters

interface	interface index
network	network prefix
mask	network mask
defaultRouter	gateway

Definition at line 386 of file ipv6-l3-protocol.cc.

References ns3::Ipv6Address::GetAny(), GetInterface(), GetRoutingProtocol(), m_prefixes, ns3::Ipv6Address::MakeAutoconfiguredAddress(), NS_LOG_FUNCTION, and RemoveAddress().

Here is the call graph for this function:

◆ RemoveMulticastAddress() [1/2]

void ns3::Ipv6L3Protocol::RemoveMulticastAddress ( Ipv6Address address )

Removes a multicast address from the list of addresses to pass to local deliver.

Parameters

address the address.

Definition at line 1740 of file ipv6-l3-protocol.cc.

References m_multicastAddressesNoInterface, and NS_LOG_FUNCTION.

◆ RemoveMulticastAddress() [2/2]

void ns3::Ipv6L3Protocol::RemoveMulticastAddress	(	Ipv6Address	address,
		uint32_t	interface
	)

Removes a multicast address from the list of addresses to pass to local deliver.

Parameters

address	the address.
interface	the incoming interface.

Definition at line 1726 of file ipv6-l3-protocol.cc.

References m_multicastAddresses, and NS_LOG_FUNCTION.

◆ ReportDrop()

void ns3::Ipv6L3Protocol::ReportDrop	(	Ipv6Header	ipHeader,
		Ptr< Packet >	p,
		DropReason	dropReason
	)

virtual

Report a packet drop.

This function is used by Fragment Timeout handling to signal a fragment drop.

Parameters

ipHeader	the IPv6 header of dropped packet
p	the packet (if available)
dropReason	the drop reason

Definition at line 1691 of file ipv6-l3-protocol.cc.

References m_dropTrace.

◆ RouteInputError()

void ns3::Ipv6L3Protocol::RouteInputError	(	Ptr< const Packet >	p,
		const Ipv6Header &	ipHeader,
		Socket::SocketErrno	sockErrno
	)

private

Fallback when no route is found.

Parameters

p	packet
ipHeader	IPv6 header
sockErrno	error number

Definition at line 1582 of file ipv6-l3-protocol.cc.

References DROP_ROUTE_ERROR, ns3::Ipv6Header::GetDestination(), GetIcmpv6(), ns3::Ipv6Header::GetSource(), ns3::Icmpv6Header::ICMPV6_NO_ROUTE, ns3::Ipv6Address::IsMulticast(), m_dropTrace, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

Referenced by Ipv6L3Protocol().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Send()

void ns3::Ipv6L3Protocol::Send	(	Ptr< Packet >	packet,
		Ipv6Address	source,
		Ipv6Address	destination,
		uint8_t	protocol,
		Ptr< Ipv6Route >	route
	)

overridevirtual

Higher-level layers call this method to send a packet down the stack to the MAC and PHY layers.

All PMTU values are stored at this level, so packet size calculations should be done mathematically at higher levels.

Parameters

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

Implements ns3::Ipv6.

Definition at line 914 of file ipv6-l3-protocol.cc.

References BuildHeader(), DROP_NO_ROUTE, ns3::SocketIpv6HopLimitTag::GetHopLimit(), GetInterfaceForAddress(), GetInterfaceForDevice(), GetNetDevice(), ns3::SocketIpv6TclassTag::GetTclass(), ns3::Ipv6Address::GetZero(), ns3::Ipv6Address::IsLinkLocal(), ns3::Ipv6Address::IsLinkLocalMulticast(), m_defaultTclass, m_defaultTtl, m_dropTrace, m_routingProtocol, m_sendOutgoingTrace, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, and SendRealOut().

Here is the call graph for this function:

◆ SendRealOut()

void ns3::Ipv6L3Protocol::SendRealOut	(	Ptr< Ipv6Route >	route,
		Ptr< Packet >	packet,
		const Ipv6Header &	ipHeader
	)

private

Send packet with route.

Parameters

route	route
packet	packet to send
ipHeader	IPv6 header to add to the packet

Definition at line 1188 of file ipv6-l3-protocol.cc.

References ns3::Ipv6Header::GetDestination(), ns3::Ipv6Header::GetSerializedSize(), ns3::Ipv6Header::GetSource(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::PeekPointer().

Referenced by IpForward(), IpMulticastForward(), and Send().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetDefaultTclass()

void ns3::Ipv6L3Protocol::SetDefaultTclass ( uint8_t tclass )

Set the default TCLASS.

Parameters

tclass TCLASS to set

Definition at line 907 of file ipv6-l3-protocol.cc.

References m_defaultTclass, and NS_LOG_FUNCTION.

◆ SetDefaultTtl()

void ns3::Ipv6L3Protocol::SetDefaultTtl ( uint8_t ttl )

Set the default TTL.

Parameters

ttl	TTL to set

Definition at line 900 of file ipv6-l3-protocol.cc.

References m_defaultTtl, and NS_LOG_FUNCTION.

◆ SetDown()

void ns3::Ipv6L3Protocol::SetDown ( uint32_t i )

overridevirtual

set an interface down.

Parameters

i	interface index

Implements ns3::Ipv6.

Definition at line 576 of file ipv6-l3-protocol.cc.

References NS_LOG_FUNCTION.

◆ SetForwarding()

void ns3::Ipv6L3Protocol::SetForwarding	(	uint32_t	i,
		bool	val
	)

overridevirtual

Enable or disable forwarding on interface.

Parameters

i	interface index
val	true = enable forwarding, false = disable

Implements ns3::Ipv6.

Definition at line 640 of file ipv6-l3-protocol.cc.

References NS_LOG_FUNCTION.

◆ SetIpForward()

void ns3::Ipv6L3Protocol::SetIpForward ( bool forward )

overrideprivatevirtual

Set IPv6 forwarding state.

Parameters

forward IPv6 forwarding enabled or not

Implements ns3::Ipv6.

Definition at line 695 of file ipv6-l3-protocol.cc.

References m_interfaces, m_ipForward, and NS_LOG_FUNCTION.

◆ SetMetric()

void ns3::Ipv6L3Protocol::SetMetric	(	uint32_t	i,
		uint16_t	metric
	)

overridevirtual

Set metric for an interface.

Parameters

i	index
metric

Implements ns3::Ipv6.

Definition at line 506 of file ipv6-l3-protocol.cc.

References NS_LOG_FUNCTION.

◆ SetMtuDiscover()

void ns3::Ipv6L3Protocol::SetMtuDiscover ( bool mtuDiscover )

overrideprivatevirtual

Set IPv6 MTU discover state.

Parameters

mtuDiscover IPv6 MTU discover enabled or not

Implements ns3::Ipv6.

Definition at line 713 of file ipv6-l3-protocol.cc.

References m_mtuDiscover, and NS_LOG_FUNCTION.

◆ SetNode()

void ns3::Ipv6L3Protocol::SetNode ( Ptr< Node > node )

Set node associated with this stack.

Parameters

node	node to set

Definition at line 758 of file ipv6-l3-protocol.cc.

References m_node, NS_LOG_FUNCTION, and SetupLoopback().

Referenced by NotifyNewAggregate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetPmtu()

void ns3::Ipv6L3Protocol::SetPmtu	(	Ipv6Address	dst,
		uint32_t	pmtu
	)

overridevirtual

Set the Path MTU for the specified IPv6 destination address.

Parameters

dst	Ipv6 destination address
pmtu	the Path MTU

Implements ns3::Ipv6.

Definition at line 534 of file ipv6-l3-protocol.cc.

References m_pmtuCache, and NS_LOG_FUNCTION.

◆ SetRoutingProtocol()

void ns3::Ipv6L3Protocol::SetRoutingProtocol ( Ptr< Ipv6RoutingProtocol > routingProtocol )

overridevirtual

Set routing protocol for this stack.

Parameters

routingProtocol IPv6 routing protocol to set

Implements ns3::Ipv6.

Definition at line 184 of file ipv6-l3-protocol.cc.

References m_routingProtocol, and NS_LOG_FUNCTION.

◆ SetSendIcmpv6Redirect()

void ns3::Ipv6L3Protocol::SetSendIcmpv6Redirect ( bool sendIcmpv6Redirect )

privatevirtual

Set the ICMPv6 Redirect sending state.

Parameters

sendIcmpv6Redirect ICMPv6 Redirect sending enabled or not

Definition at line 726 of file ipv6-l3-protocol.cc.

References m_sendIcmpv6Redirect, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ SetStrongEndSystemModel()

void ns3::Ipv6L3Protocol::SetStrongEndSystemModel ( bool model )

overrideprivatevirtual

Set or unset the Strong End System Model.

RFC1122 term for whether host rejects datagram with a dest. address on another interface

Parameters

model true for Strong End System Model

Implements ns3::Ipv6.

Definition at line 1818 of file ipv6-l3-protocol.cc.

References m_strongEndSystemModel, and NS_LOG_FUNCTION.

◆ SetUp()

void ns3::Ipv6L3Protocol::SetUp ( uint32_t i )

overridevirtual

Set an interface up.

Parameters

i	interface index

Implements ns3::Ipv6.

Definition at line 548 of file ipv6-l3-protocol.cc.

References NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ SetupLoopback()

void ns3::Ipv6L3Protocol::SetupLoopback ( )

private

Setup loopback interface.

Definition at line 590 of file ipv6-l3-protocol.cc.

References ns3::Node::AddDevice(), AddIpv6Interface(), ns3::CreateObject(), ns3::Node::GetDevice(), ns3::Ipv6Address::GetLoopback(), ns3::Node::GetNDevices(), m_node, m_routingProtocol, ns3::MakeCallback(), NS_LOG_FUNCTION, PROT_NUMBER, and Receive().

Referenced by SetNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SourceAddressSelection()

Ipv6Address ns3::Ipv6L3Protocol::SourceAddressSelection	(	uint32_t	interface,
		Ipv6Address	dest
	)

overridevirtual

Choose the source address to use with destination address.

Parameters

interface	interface index
dest	IPv6 destination address

Returns: IPv6 source address to use

Implements ns3::Ipv6.

Definition at line 648 of file ipv6-l3-protocol.cc.

References GetAddress(), ns3::Ipv6Address::GetLoopback(), GetNAddresses(), ns3::Ipv6InterfaceAddress::GLOBAL, ns3::Ipv6Address::IsAny(), ns3::Ipv6Address::IsLinkLocal(), ns3::Ipv6Address::IsLinkLocalMulticast(), ns3::Ipv6Address::IsLocalhost(), ns3::Ipv6InterfaceAddress::LINKLOCAL, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Friends And Related Function Documentation

◆ ::Ipv6L3ProtocolTestCase

friend class ::Ipv6L3ProtocolTestCase

friend

Ipv6L3ProtocolTestCase test case.

Definition at line 509 of file ipv6-l3-protocol.h.

◆ Ipv6ExtensionLooseRouting

friend class Ipv6ExtensionLooseRouting

friend

Ipv6ExtensionLooseRouting.

Definition at line 514 of file ipv6-l3-protocol.h.

Member Data Documentation

◆ m_defaultTclass

uint8_t ns3::Ipv6L3Protocol::m_defaultTclass

private

Default TCLASS for outgoing packets.

Definition at line 761 of file ipv6-l3-protocol.h.

Referenced by GetTypeId(), Send(), and SetDefaultTclass().

◆ m_defaultTtl

uint8_t ns3::Ipv6L3Protocol::m_defaultTtl

private

Default TTL for outgoing packets.

Definition at line 756 of file ipv6-l3-protocol.h.

Referenced by GetTypeId(), Send(), and SetDefaultTtl().

◆ m_dropTrace

TracedCallback<const Ipv6Header&, Ptr<const Packet>, DropReason, Ptr<Ipv6>, uint32_t> ns3::Ipv6L3Protocol::m_dropTrace

private

Callback to trace drop packets.

Deprecated:: The non-const Ptr<Ipv6> argument is deprecated and will be changed to Ptr<const Ipv6> in a future release.

Definition at line 586 of file ipv6-l3-protocol.h.

Referenced by GetTypeId(), IpForward(), IpMulticastForward(), LocalDeliver(), ReportDrop(), RouteInputError(), and Send().

◆ m_ecb

Ipv6RoutingProtocol::ErrorCallback ns3::Ipv6L3Protocol::m_ecb

private

Error callback.

Definition at line 841 of file ipv6-l3-protocol.h.

Referenced by Ipv6L3Protocol().

◆ m_interfaces

Ipv6InterfaceList ns3::Ipv6L3Protocol::m_interfaces

private

List of IPv6 interfaces.

Definition at line 741 of file ipv6-l3-protocol.h.

Referenced by AddIpv6Interface(), DoDispose(), GetInterface(), GetInterfaceForAddress(), GetInterfaceForPrefix(), GetTypeId(), ReachabilityHint(), and SetIpForward().

◆ m_ipForward

bool ns3::Ipv6L3Protocol::m_ipForward

private

Forwarding packets (i.e.

router mode) state.

Definition at line 721 of file ipv6-l3-protocol.h.

Referenced by AddInterface(), GetIpForward(), and SetIpForward().

◆ m_lcb

Ipv6RoutingProtocol::LocalDeliverCallback ns3::Ipv6L3Protocol::m_lcb

private

Local delivery callback.

Definition at line 840 of file ipv6-l3-protocol.h.

Referenced by Ipv6L3Protocol().

◆ m_localDeliverTrace

TracedCallback<const Ipv6Header&, Ptr<const Packet>, uint32_t> ns3::Ipv6L3Protocol::m_localDeliverTrace

private

Trace of locally delivered packets.

Definition at line 593 of file ipv6-l3-protocol.h.

Referenced by GetTypeId(), and LocalDeliver().

◆ m_mcb

Ipv6RoutingProtocol::MulticastForwardCallback ns3::Ipv6L3Protocol::m_mcb

private

Multicast forward callback.

Definition at line 839 of file ipv6-l3-protocol.h.

Referenced by Ipv6L3Protocol().

◆ m_mtuDiscover

bool ns3::Ipv6L3Protocol::m_mtuDiscover

private

MTU Discover (i.e.

Path MTU) state.

Definition at line 726 of file ipv6-l3-protocol.h.

Referenced by GetMtu(), GetMtuDiscover(), and SetMtuDiscover().

◆ m_multicastAddresses

Ipv6RegisteredMulticastAddress_t ns3::Ipv6L3Protocol::m_multicastAddresses

private

List of multicast IP addresses of interest, divided per interface.

Definition at line 831 of file ipv6-l3-protocol.h.

Referenced by AddMulticastAddress(), IsRegisteredMulticastAddress(), and RemoveMulticastAddress().

◆ m_multicastAddressesNoInterface

Ipv6RegisteredMulticastAddressNoInterface_t ns3::Ipv6L3Protocol::m_multicastAddressesNoInterface

private

List of multicast IP addresses of interest for all the interfaces.

Definition at line 836 of file ipv6-l3-protocol.h.

Referenced by AddMulticastAddress(), IsRegisteredMulticastAddress(), and RemoveMulticastAddress().

◆ m_nInterfaces

uint32_t ns3::Ipv6L3Protocol::m_nInterfaces

private

Number of IPv6 interfaces managed by the stack.

Definition at line 751 of file ipv6-l3-protocol.h.

Referenced by AddIpv6Interface(), and GetNInterfaces().

◆ m_node

Ptr<Node> ns3::Ipv6L3Protocol::m_node

private

Node attached to stack.

Definition at line 716 of file ipv6-l3-protocol.h.

Referenced by AddAutoconfiguredAddress(), AddInterface(), CreateRawSocket(), DoDispose(), IpForward(), IpMulticastForward(), LocalDeliver(), NotifyNewAggregate(), Receive(), RegisterExtensions(), RegisterOptions(), SetNode(), and SetupLoopback().

◆ m_pmtuCache

Ptr<Ipv6PmtuCache> ns3::Ipv6L3Protocol::m_pmtuCache

private

Path MTU Cache.

Definition at line 731 of file ipv6-l3-protocol.h.

Referenced by Ipv6L3Protocol(), DoDispose(), and SetPmtu().

◆ m_prefixes

Ipv6AutoconfiguredPrefixList ns3::Ipv6L3Protocol::m_prefixes

private

List of IPv6 prefix received from RA.

Definition at line 781 of file ipv6-l3-protocol.h.

Referenced by AddAutoconfiguredAddress(), DoDispose(), and RemoveAutoconfiguredAddress().

◆ m_protocols

L4List_t ns3::Ipv6L3Protocol::m_protocols

private

List of transport protocol.

Definition at line 736 of file ipv6-l3-protocol.h.

Referenced by DoDispose(), GetProtocol(), Insert(), and Remove().

◆ m_reverseInterfacesContainer

Ipv6InterfaceReverseContainer ns3::Ipv6L3Protocol::m_reverseInterfacesContainer

private

Container of NetDevice / Interface index associations.

Definition at line 746 of file ipv6-l3-protocol.h.

Referenced by AddIpv6Interface(), DoDispose(), and GetInterfaceForDevice().

◆ m_routingProtocol

Ptr<Ipv6RoutingProtocol> ns3::Ipv6L3Protocol::m_routingProtocol

private

Routing protocol.

Definition at line 771 of file ipv6-l3-protocol.h.

Referenced by AddAutoconfiguredAddress(), DoDispose(), GetRoutingProtocol(), Send(), SetRoutingProtocol(), and SetupLoopback().

◆ m_rxTrace

TracedCallback<Ptr<const Packet>, Ptr<Ipv6>, uint32_t> ns3::Ipv6L3Protocol::m_rxTrace

private

Callback to trace RX (reception) packets.

Deprecated:: The non-const Ptr<Ipv6> argument is deprecated and will be changed to Ptr<const Ipv6> in a future release.

Definition at line 578 of file ipv6-l3-protocol.h.

Referenced by GetTypeId().

◆ m_sendIcmpv6Redirect

bool ns3::Ipv6L3Protocol::m_sendIcmpv6Redirect

private

Allow ICMPv6 Redirect sending state.

Definition at line 786 of file ipv6-l3-protocol.h.

Referenced by GetSendIcmpv6Redirect(), IpForward(), and SetSendIcmpv6Redirect().

◆ m_sendOutgoingTrace

TracedCallback<const Ipv6Header&, Ptr<const Packet>, uint32_t> ns3::Ipv6L3Protocol::m_sendOutgoingTrace

private

Trace of sent packets.

Definition at line 589 of file ipv6-l3-protocol.h.

Referenced by GetTypeId(), and Send().

◆ m_sockets

SocketList ns3::Ipv6L3Protocol::m_sockets

private

List of IPv6 raw sockets.

Definition at line 776 of file ipv6-l3-protocol.h.

Referenced by CreateRawSocket(), DeleteRawSocket(), and DoDispose().

◆ m_strongEndSystemModel

bool ns3::Ipv6L3Protocol::m_strongEndSystemModel

private

Rejects packets directed to an interface with wrong address (RFC 1222).

Definition at line 766 of file ipv6-l3-protocol.h.

Referenced by GetStrongEndSystemModel(), and SetStrongEndSystemModel().

◆ m_txTrace

TracedCallback<Ptr<const Packet>, Ptr<Ipv6>, uint32_t> ns3::Ipv6L3Protocol::m_txTrace

private

Callback to trace TX (transmission) packets.

Deprecated:: The non-const Ptr<Ipv6> argument is deprecated and will be changed to Ptr<const Ipv6> in a future release.

Definition at line 571 of file ipv6-l3-protocol.h.

Referenced by CallTxTrace(), and GetTypeId().

◆ m_ucb

Ipv6RoutingProtocol::UnicastForwardCallback ns3::Ipv6L3Protocol::m_ucb

private

Unicast forward callback.

Definition at line 838 of file ipv6-l3-protocol.h.

Referenced by Ipv6L3Protocol().

◆ m_unicastForwardTrace

TracedCallback<const Ipv6Header&, Ptr<const Packet>, uint32_t> ns3::Ipv6L3Protocol::m_unicastForwardTrace

private

Trace of unicast forwarded packets.

Definition at line 591 of file ipv6-l3-protocol.h.

Referenced by GetTypeId(), and IpForward().

◆ PROT_NUMBER

const uint16_t ns3::Ipv6L3Protocol::PROT_NUMBER = 0x86DD

static

The protocol number for IPv6 (0x86DD).

Definition at line 75 of file ipv6-l3-protocol.h.

Referenced by ns3::NoBackhaulEpcHelper::AddEnb(), AddInterface(), ns3::EpcTftClassifier::Classify(), EpcTftClassifierTestCase::DoRun(), ns3::NdiscCache::Entry::FunctionDelayTimeout(), ns3::NdiscCache::Entry::FunctionProbeTimeout(), ns3::Icmpv6L4Protocol::HandleNS(), ns3::LteNetDevice::Receive(), ns3::SixLowPanNetDevice::ReceiveFromDevice(), ns3::EpcPgwApplication::RecvFromTunDevice(), ns3::Ipv6Interface::Send(), ns3::LteEnbNetDevice::Send(), ns3::LteUeNetDevice::Send(), and SetupLoopback().

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

src/internet/model/ipv6-l3-protocol.h
src/internet/model/ipv6-l3-protocol.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Related Functions

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Ipv6

TraceSources

Member Typedef Documentation

◆ DropTracedCallback

◆ Ipv6AutoconfiguredPrefixList

◆ Ipv6AutoconfiguredPrefixListI

◆ Ipv6InterfaceList

◆ Ipv6InterfaceReverseContainer

◆ Ipv6RegisteredMulticastAddress_t

◆ Ipv6RegisteredMulticastAddressCIter_t

◆ Ipv6RegisteredMulticastAddressIter_t

◆ Ipv6RegisteredMulticastAddressKey_t

◆ Ipv6RegisteredMulticastAddressNoInterface_t

◆ Ipv6RegisteredMulticastAddressNoInterfaceCIter_t

◆ Ipv6RegisteredMulticastAddressNoInterfaceIter_t

◆ L4List_t

◆ L4ListKey_t

◆ SentTracedCallback

◆ SocketList

◆ TxRxTracedCallback

Member Enumeration Documentation

◆ DropReason

Constructor & Destructor Documentation

◆ Ipv6L3Protocol() [1/2]

◆ ~Ipv6L3Protocol()

◆ Ipv6L3Protocol() [2/2]

Member Function Documentation

◆ AddAddress()

◆ AddAutoconfiguredAddress()

◆ AddInterface()

◆ AddIpv6Interface()

◆ AddMulticastAddress() [1/2]

◆ AddMulticastAddress() [2/2]

◆ BuildHeader()

◆ CallTxTrace()

◆ CreateRawSocket()

◆ DeleteRawSocket()

◆ DoDispose()

◆ GetAddress()

◆ GetIcmpv6()

◆ GetInterface()

◆ GetInterfaceForAddress()

◆ GetInterfaceForDevice()

◆ GetInterfaceForPrefix()

◆ GetIpForward()

◆ GetMetric()

◆ GetMtu()

◆ GetMtuDiscover()

◆ GetNAddresses()

◆ GetNetDevice()

◆ GetNInterfaces()

◆ GetProtocol() [1/2]

◆ GetProtocol() [2/2]

◆ GetRoutingProtocol()

◆ GetSendIcmpv6Redirect()

◆ GetStrongEndSystemModel()

◆ GetTypeId()

◆ Insert() [1/2]

◆ Insert() [2/2]

◆ IpForward()

◆ IpMulticastForward()

◆ IsForwarding()

◆ IsRegisteredMulticastAddress() [1/2]

◆ IsRegisteredMulticastAddress() [2/2]

◆ IsUp()

◆ LocalDeliver()