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 }
	Reason why a packet has been dropped. More...
Public Member Functions
	Ipv6L3Protocol ()
	Constructor.
virtual	~Ipv6L3Protocol ()
	Destructor.
void	SetNode (Ptr< Node > node)
	Set node for this stack.
void	Insert (Ptr< Ipv6L4Protocol > protocol)
	Add an L4 protocol.
void	Remove (Ptr< Ipv6L4Protocol > protocol)
	Remove an L4 protocol.
Ptr< Ipv6L4Protocol >	GetProtocol (int protocolNumber) const
	Get L4 protocol by protocol number.
Ptr< Socket >	CreateRawSocket ()
	Create raw IPv6 socket.
void	DeleteRawSocket (Ptr< Socket > socket)
	Remove raw IPv6 socket.
void	SetDefaultTtl (uint8_t ttl)
	Set the default TTL.
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. This method removes IPv6 header and forward up to L4 protocol.
void	Send (Ptr< Packet > packet, Ipv6Address source, Ipv6Address destination, uint8_t protocol, Ptr< Ipv6Route > route)
	Higher-level layers call this method to send a packet down the stack to the MAC and PHY layers.
void	SetRoutingProtocol (Ptr< Ipv6RoutingProtocol > routingProtocol)
	Set routing protocol for this stack.
Ptr< Ipv6RoutingProtocol >	GetRoutingProtocol () const
	Get current routing protocol used.
uint32_t	AddInterface (Ptr< NetDevice > device)
	Add IPv6 interface for a device.
Ptr< Ipv6Interface >	GetInterface (uint32_t i) const
	Get an interface.
uint32_t	GetNInterfaces () const
	Get current number of interface on this stack.
int32_t	GetInterfaceForAddress (Ipv6Address addr) const
	Get interface index which has specified IPv6 address.
int32_t	GetInterfaceForPrefix (Ipv6Address addr, Ipv6Prefix mask) const
	Get interface index which match specified address/prefix.
int32_t	GetInterfaceForDevice (Ptr< const NetDevice > device) const
	Get interface index which is on a specified net device.
bool	AddAddress (uint32_t i, Ipv6InterfaceAddress address)
	Add an address on interface.
Ipv6InterfaceAddress	GetAddress (uint32_t interfaceIndex, uint32_t addressIndex) const
	Get an address.
uint32_t	GetNAddresses (uint32_t interface) const
	Get number of address for an interface.
bool	RemoveAddress (uint32_t interfaceIndex, uint32_t addressIndex)
	Remove an address from an interface.
void	SetMetric (uint32_t i, uint16_t metric)
	Set metric for an interface.
uint16_t	GetMetric (uint32_t i) const
	Get metric for an interface.
uint16_t	GetMtu (uint32_t i) const
	Get MTU for an interface.
bool	IsUp (uint32_t i) const
	Is specified interface up ?
void	SetUp (uint32_t i)
	Set an interface up.
void	SetDown (uint32_t i)
	set an interface down.
bool	IsForwarding (uint32_t i) const
	Is interface allows forwarding ?
void	SetForwarding (uint32_t i, bool val)
	Enable or disable forwarding on interface.
Ptr< NetDevice >	GetNetDevice (uint32_t i)
	Get device by index.
Ptr< Icmpv6L4Protocol >	GetIcmpv6 () const
	Get ICMPv6 protocol.
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.
void	RemoveAutoconfiguredAddress (uint32_t interface, Ipv6Address network, Ipv6Prefix mask, Ipv6Address defaultRouter)
	Remove an autoconfigured address.
virtual void	RegisterExtensions ()
	Register the IPv6 Extensions.
virtual void	RegisterOptions ()
	Register the IPv6 Options.
Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID of this class.
Static Public Attributes
static const uint16_t	PROT_NUMBER
	The protocol number for IPv6 (0x86DD).
Protected Member Functions
virtual void	DoDispose ()
	Dispose object.
virtual void	NotifyNewAggregate ()
	Notify other components connected to the node that a new stack member is now connected.
Friends
class	Ipv6L3ProtocolTestCase
class	Ipv6ExtensionLooseRouting

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.

Member Enumeration Documentation

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	Unkown L4 protocol

Member Function Documentation

bool ns3::Ipv6L3Protocol::AddAddress	(	uint32_t	i,
		Ipv6InterfaceAddress	address
	)			`[virtual]`

Add an address on interface.

Parameters:

	i	interface index
	address	to add

Implements ns3::Ipv6.

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

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

Add IPv6 interface for a device.

Parameters:

device

net device

Returns:: interface index

Implements ns3::Ipv6.

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

Create raw IPv6 socket.

Returns:: newly raw socket

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

Remove raw IPv6 socket.

Parameters:

socket

socket to remove

Ipv6InterfaceAddress ns3::Ipv6L3Protocol::GetAddress	(	uint32_t	interfaceIndex,
		uint32_t	addressIndex
	)			const `[virtual]`

Get an address.

Parameters:

	interfaceIndex	interface index
	addressIndex	address index on the interface

Returns:: Ipv6InterfaceAddress or assert if not found

Implements ns3::Ipv6.

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

Get ICMPv6 protocol.

Returns:: Icmpv6L4Protocol pointer

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

Get an interface.

Parameters:

i

interface index

Returns:: IPv6 interface pointer

int32_t ns3::Ipv6L3Protocol::GetInterfaceForAddress ( Ipv6Address addr ) const [virtual]

Get interface index which has specified IPv6 address.

Parameters:

addr

IPv6 address

Returns:: interface index or -1 if not found

Implements ns3::Ipv6.

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

Get interface index which is on a specified net device.

Parameters:

device

net device

Implements ns3::Ipv6.

int32_t ns3::Ipv6L3Protocol::GetInterfaceForPrefix	(	Ipv6Address	addr,
		Ipv6Prefix	mask
	)			const `[virtual]`

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.

uint16_t ns3::Ipv6L3Protocol::GetMetric ( uint32_t i ) const [virtual]

Get metric for an interface.

Parameters:

i

index

Returns:: metric

Implements ns3::Ipv6.

uint16_t ns3::Ipv6L3Protocol::GetMtu ( uint32_t i ) const [virtual]

Get MTU for an interface.

Parameters:

i

index

Returns:: MTU

Implements ns3::Ipv6.

uint32_t ns3::Ipv6L3Protocol::GetNAddresses ( uint32_t interface ) const [virtual]

Get number of address for an interface.

Parameters:

interface

interface index

Returns:: number of address

Implements ns3::Ipv6.

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

Get device by index.

Parameters:

i

device index on this stack

Returns:: NetDevice pointer

Implements ns3::Ipv6.

uint32_t ns3::Ipv6L3Protocol::GetNInterfaces ( ) const [virtual]

Get current number of interface on this stack.

Returns:: number of interface registered

Implements ns3::Ipv6.

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

Get L4 protocol by protocol number.

Parameters:

protocolNumber

protocol number

Returns:: corresponding Ipv6L4Protocol or 0 if not found

Ptr<Ipv6RoutingProtocol> ns3::Ipv6L3Protocol::GetRoutingProtocol ( ) const [virtual]

Get current routing protocol used.

Returns:: routing protocol

Implements ns3::Ipv6.

static TypeId ns3::Ipv6L3Protocol::GetTypeId ( void ) [static]

Get the type ID of this class.

This method returns the TypeId associated to ns3::Ipv6L3Protocol.

Returns:: type ID

Attributes defined for this type:

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: construct write read
InterfaceList: The set of IPv6 interfaces associated to this IPv6 stack.
- Set with class: ns3::ObjectVectorValue
- Underlying type: ns3::Ptr< ns3::Ipv6Interface >
- Flags: read

Attributes defined in parent class ns3::Ipv6:

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

TraceSources defined for this type:

Tx: Send IPv6 packet to outgoing interface.
Rx: Receive IPv6 packet from incoming interface.
Drop: Drop IPv6 packet

Reimplemented from ns3::Ipv6.

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

Add an L4 protocol.

Parameters:

protocol

L4 protocol

bool ns3::Ipv6L3Protocol::IsForwarding ( uint32_t i ) const [virtual]

Is interface allows forwarding ?

Parameters:

i

interface index

Implements ns3::Ipv6.

bool ns3::Ipv6L3Protocol::IsUp ( uint32_t i ) const [virtual]

Is specified interface up ?

Parameters:

i

interface index

Implements ns3::Ipv6.

virtual void ns3::Ipv6L3Protocol::NotifyNewAggregate ( ) [protected, virtual]

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.

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 correspondant
	to	address of the destination
	packetType	type of the packet

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

Remove an L4 protocol.

Parameters:

protocol

L4 protocol to remove

bool ns3::Ipv6L3Protocol::RemoveAddress	(	uint32_t	interfaceIndex,
		uint32_t	addressIndex
	)			`[virtual]`

Remove an address from an interface.

Parameters:

	interfaceIndex	interface index
	addressIndex	address index on the interface

Implements ns3::Ipv6.

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

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

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

Parameters:

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

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

Set the default TTL.

Parameters:

ttl

TTL to set

void ns3::Ipv6L3Protocol::SetDown ( uint32_t i ) [virtual]

set an interface down.

Parameters:

i

interface index

Implements ns3::Ipv6.

void ns3::Ipv6L3Protocol::SetForwarding	(	uint32_t	i,
		bool	val
	)			`[virtual]`

Enable or disable forwarding on interface.

Parameters:

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

Implements ns3::Ipv6.

void ns3::Ipv6L3Protocol::SetMetric	(	uint32_t	i,
		uint16_t	metric
	)			`[virtual]`

Set metric for an interface.

Parameters:

	i	index
	metric

Implements ns3::Ipv6.

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

Set node for this stack.

Parameters:

node

node to set

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

Set routing protocol for this stack.

Parameters:

routingProtocol

IPv6 routing protocol to set

Implements ns3::Ipv6.

void ns3::Ipv6L3Protocol::SetUp ( uint32_t i ) [virtual]

Set an interface up.

Parameters:

i

interface index

Implements ns3::Ipv6.

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

src/internet-stack/ipv6-l3-protocol.h
doc/introspected-doxygen.h

ns3::Ipv6L3Protocol Class Reference

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

Member Function Documentation