ns3::Ipv6RoutingTableEntry Class Reference

A record of an IPv6 route. More...

#include "ipv6-routing-table-entry.h"

Inheritance diagram for ns3::Ipv6RoutingTableEntry:

Collaboration diagram for ns3::Ipv6RoutingTableEntry:

Public Member Functions
	Ipv6RoutingTableEntry ()
	Constructor.
	Ipv6RoutingTableEntry (const Ipv6RoutingTableEntry &route)
	Copy constructor.
	Ipv6RoutingTableEntry (const Ipv6RoutingTableEntry *route)
	Copy constructor.
virtual	~Ipv6RoutingTableEntry ()
	Destructor.
Ipv6Address	GetDest () const
	Get the destination.
Ipv6Address	GetDestNetwork () const
	Get the destination network.
Ipv6Prefix	GetDestNetworkPrefix () const
	Get the destination prefix.
Ipv6Address	GetGateway () const
	Get the gateway.
uint32_t	GetInterface () const
	Get the interface index.
Ipv6Address	GetPrefixToUse () const
	Get the prefix to use (for multihomed link).
bool	IsDefault () const
	Is it the default route ?
bool	IsGateway () const
	Is it the gateway ?
bool	IsHost () const
	Is the route entry correspond to a host ?
bool	IsNetwork () const
	Is the route entry correspond to a network ?
void	SetPrefixToUse (Ipv6Address prefix)
	Set the prefix to use.

Static Public Member Functions
static Ipv6RoutingTableEntry	CreateDefaultRoute (Ipv6Address nextHop, uint32_t interface)
	Create a default route.
static Ipv6RoutingTableEntry	CreateHostRouteTo (Ipv6Address dest, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse=Ipv6Address())
	Create a route to a host.
static Ipv6RoutingTableEntry	CreateHostRouteTo (Ipv6Address dest, uint32_t interface)
	Create a route to a host.
static Ipv6RoutingTableEntry	CreateNetworkRouteTo (Ipv6Address network, Ipv6Prefix networkPrefix, Ipv6Address nextHop, uint32_t interface)
	Create a route to a network.
static Ipv6RoutingTableEntry	CreateNetworkRouteTo (Ipv6Address network, Ipv6Prefix networkPrefix, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse)
	Create a route to a network.
static Ipv6RoutingTableEntry	CreateNetworkRouteTo (Ipv6Address network, Ipv6Prefix networkPrefix, uint32_t interface)
	Create a route to a network.

Private Member Functions
	Ipv6RoutingTableEntry (Ipv6Address dest, Ipv6Address gateway, uint32_t interface)
	Constructor.
	Ipv6RoutingTableEntry (Ipv6Address dest, Ipv6Prefix prefix, uint32_t interface)
	Constructor.
	Ipv6RoutingTableEntry (Ipv6Address dest, uint32_t interface)
	Constructor.
	Ipv6RoutingTableEntry (Ipv6Address network, Ipv6Prefix prefix, Ipv6Address gateway, uint32_t interface)
	Constructor.
	Ipv6RoutingTableEntry (Ipv6Address network, Ipv6Prefix prefix, Ipv6Address gateway, uint32_t interface, Ipv6Address prefixToUse)
	Constructor.
	Ipv6RoutingTableEntry (Ipv6Address network, Ipv6Prefix prefix, uint32_t interface, Ipv6Address prefixToUse)
	Constructor.

Private Attributes
Ipv6Address	m_dest
	IPv6 address of the destination.
Ipv6Prefix	m_destNetworkPrefix
	IPv6 prefix of the destination.
Ipv6Address	m_gateway
	IPv6 address of the gateway.
uint32_t	m_interface
	The interface index.
Ipv6Address	m_prefixToUse
	Prefix to use.

Detailed Description

A record of an IPv6 route.

Definition at line 26 of file ipv6-routing-table-entry.h.

Constructor & Destructor Documentation

Ipv6RoutingTableEntry() [1/9]

ns3::Ipv6RoutingTableEntry::Ipv6RoutingTableEntry

(

)

Constructor.

Definition at line 16 of file ipv6-routing-table-entry.cc.

Referenced by Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), ns3::RipNgRoutingTableEntry::RipNgRoutingTableEntry(), ns3::RipNgRoutingTableEntry::RipNgRoutingTableEntry(), CreateDefaultRoute(), CreateHostRouteTo(), CreateHostRouteTo(), CreateNetworkRouteTo(), CreateNetworkRouteTo(), and CreateNetworkRouteTo().

Here is the caller graph for this function:

Ipv6RoutingTableEntry() [2/9]

ns3::Ipv6RoutingTableEntry::Ipv6RoutingTableEntry

(

const Ipv6RoutingTableEntry &

route

)

Copy constructor.

Parameters

route

the route to copy

Definition at line 20 of file ipv6-routing-table-entry.cc.

References Ipv6RoutingTableEntry(), m_dest, m_destNetworkPrefix, m_gateway, m_interface, and m_prefixToUse.

Here is the call graph for this function:

Ipv6RoutingTableEntry() [3/9]

ns3::Ipv6RoutingTableEntry::Ipv6RoutingTableEntry

(

const Ipv6RoutingTableEntry *

route

)

Copy constructor.

Parameters

route

the route to copy

Definition at line 29 of file ipv6-routing-table-entry.cc.

References Ipv6RoutingTableEntry(), m_dest, m_destNetworkPrefix, m_gateway, m_interface, and m_prefixToUse.

Here is the call graph for this function:

~Ipv6RoutingTableEntry()

ns3::Ipv6RoutingTableEntry::~Ipv6RoutingTableEntry ( )

virtual

Destructor.

Definition at line 106 of file ipv6-routing-table-entry.cc.

Ipv6RoutingTableEntry() [4/9]

ns3::Ipv6RoutingTableEntry::Ipv6RoutingTableEntry ( Ipv6Address network, Ipv6Prefix prefix, Ipv6Address gateway, uint32_t interface )

private

Constructor.

Parameters

network	network address
prefix	network prefix
gateway	the gateway
interface	the interface index

Definition at line 71 of file ipv6-routing-table-entry.cc.

References m_dest, m_destNetworkPrefix, m_gateway, m_interface, and m_prefixToUse.

Ipv6RoutingTableEntry() [5/9]

ns3::Ipv6RoutingTableEntry::Ipv6RoutingTableEntry ( Ipv6Address network, Ipv6Prefix prefix, uint32_t interface, Ipv6Address prefixToUse )

private

Constructor.

Parameters

network	network address
prefix	network prefix
interface	the interface index
prefixToUse	prefix to use

Definition at line 83 of file ipv6-routing-table-entry.cc.

References m_dest, m_destNetworkPrefix, m_gateway, m_interface, and m_prefixToUse.

Ipv6RoutingTableEntry() [6/9]

ns3::Ipv6RoutingTableEntry::Ipv6RoutingTableEntry ( Ipv6Address network, Ipv6Prefix prefix, Ipv6Address gateway, uint32_t interface, Ipv6Address prefixToUse )

private

Constructor.

Parameters

network	network address
prefix	network prefix
gateway	the gateway
interface	the interface index
prefixToUse	prefix to use

Definition at line 58 of file ipv6-routing-table-entry.cc.

References m_dest, m_destNetworkPrefix, m_gateway, m_interface, and m_prefixToUse.

Ipv6RoutingTableEntry() [7/9]

ns3::Ipv6RoutingTableEntry::Ipv6RoutingTableEntry ( Ipv6Address dest, Ipv6Prefix prefix, uint32_t interface )

private

Constructor.

Parameters

dest	destination address
prefix	destination prefix
interface	interface index

Definition at line 95 of file ipv6-routing-table-entry.cc.

References m_dest, m_destNetworkPrefix, m_gateway, m_interface, and m_prefixToUse.

Ipv6RoutingTableEntry() [8/9]

ns3::Ipv6RoutingTableEntry::Ipv6RoutingTableEntry ( Ipv6Address dest, Ipv6Address gateway, uint32_t interface )

private

Constructor.

Parameters

dest	destination address
gateway	the gateway
interface	interface index

Definition at line 38 of file ipv6-routing-table-entry.cc.

References m_dest, m_destNetworkPrefix, m_gateway, m_interface, and m_prefixToUse.

Ipv6RoutingTableEntry() [9/9]

ns3::Ipv6RoutingTableEntry::Ipv6RoutingTableEntry ( Ipv6Address dest, uint32_t interface )

private

Constructor.

Parameters

dest	destination address
interface	interface index

Definition at line 49 of file ipv6-routing-table-entry.cc.

References m_dest, m_destNetworkPrefix, m_gateway, m_interface, and m_prefixToUse.

Member Function Documentation

CreateDefaultRoute()

Ipv6RoutingTableEntry ns3::Ipv6RoutingTableEntry::CreateDefaultRoute ( Ipv6Address nextHop, uint32_t interface )

static

Create a default route.

Parameters

nextHop	next hop address to route the packet
interface	interface index

Returns

IPv6Route object

Definition at line 213 of file ipv6-routing-table-entry.cc.

References Ipv6RoutingTableEntry(), and ns3::Ipv6Address::GetZero().

Here is the call graph for this function:

CreateHostRouteTo() [1/2]

Ipv6RoutingTableEntry ns3::Ipv6RoutingTableEntry::CreateHostRouteTo ( Ipv6Address dest, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse = Ipv6Address() )

static

Create a route to a host.

Parameters

dest	destination address
nextHop	next hop address to route the packet
interface	interface index
prefixToUse	prefix that should be used for source address for this destination

Returns

IPv6Route object

Definition at line 171 of file ipv6-routing-table-entry.cc.

References Ipv6RoutingTableEntry(), and ns3::Ipv6Prefix::GetOnes().

Here is the call graph for this function:

CreateHostRouteTo() [2/2]

Ipv6RoutingTableEntry ns3::Ipv6RoutingTableEntry::CreateHostRouteTo ( Ipv6Address dest, uint32_t interface )

static

Create a route to a host.

Parameters

dest	destination address
interface	interface index

Returns

IPv6Route object

Definition at line 180 of file ipv6-routing-table-entry.cc.

References Ipv6RoutingTableEntry().

Here is the call graph for this function:

CreateNetworkRouteTo() [1/3]

Ipv6RoutingTableEntry ns3::Ipv6RoutingTableEntry::CreateNetworkRouteTo ( Ipv6Address network, Ipv6Prefix networkPrefix, Ipv6Address nextHop, uint32_t interface )

static

Create a route to a network.

Parameters

network	network address
networkPrefix	network prefix
nextHop	next hop address to route the packet
interface	interface index

Returns

IPv6Route object

Definition at line 186 of file ipv6-routing-table-entry.cc.

References Ipv6RoutingTableEntry().

Referenced by ns3::RipNgRoutingTableEntry::RipNgRoutingTableEntry(), ns3::RipNgRoutingTableEntry::RipNgRoutingTableEntry(), ns3::Ipv6StaticRouting::AddNetworkRouteTo(), ns3::Ipv6StaticRouting::AddNetworkRouteTo(), ns3::Ipv6StaticRouting::AddNetworkRouteTo(), and ns3::Ipv6StaticRouting::SetDefaultMulticastRoute().

Here is the call graph for this function:

Here is the caller graph for this function:

CreateNetworkRouteTo() [2/3]

Ipv6RoutingTableEntry ns3::Ipv6RoutingTableEntry::CreateNetworkRouteTo ( Ipv6Address network, Ipv6Prefix networkPrefix, Ipv6Address nextHop, uint32_t interface, Ipv6Address prefixToUse )

static

Create a route to a network.

Parameters

network	network address
networkPrefix	network prefix
nextHop	next hop address to route the packet
interface	interface index
prefixToUse	prefix that should be used for source address for this destination

Returns

IPv6Route object

Definition at line 195 of file ipv6-routing-table-entry.cc.

References Ipv6RoutingTableEntry().

Here is the call graph for this function:

CreateNetworkRouteTo() [3/3]

Ipv6RoutingTableEntry ns3::Ipv6RoutingTableEntry::CreateNetworkRouteTo ( Ipv6Address network, Ipv6Prefix networkPrefix, uint32_t interface )

static

Create a route to a network.

Parameters

network	network address
networkPrefix	network prefix
interface	interface index

Returns

IPv6Route object

Definition at line 205 of file ipv6-routing-table-entry.cc.

References Ipv6RoutingTableEntry().

Here is the call graph for this function:

GetDest()

Ipv6Address ns3::Ipv6RoutingTableEntry::GetDest

(

)

const

Get the destination.

Returns

the IPv6 address of the destination of this route

Definition at line 117 of file ipv6-routing-table-entry.cc.

References m_dest.

Referenced by ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupRoute(), ns3::Ipv6StaticRouting::LookupStatic(), ns3::operator<<(), ns3::Ipv6StaticRouting::PrintRoutingTable(), ns3::RipNg::PrintRoutingTable(), StackHelper::PrintRoutingTable(), and ns3::Ipv6StaticRouting::RemoveRoute().

Here is the caller graph for this function:

GetDestNetwork()

Ipv6Address ns3::Ipv6RoutingTableEntry::GetDestNetwork

(

)

const

Get the destination network.

Returns

the destination network

Definition at line 147 of file ipv6-routing-table-entry.cc.

References m_dest.

Referenced by ns3::Ipv6StaticRouting::GetDefaultRoute(), ns3::Ipv6StaticRouting::HasNetworkDest(), ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupStatic(), ns3::Ipv6StaticRouting::NotifyRemoveRoute(), and ns3::operator<<().

Here is the caller graph for this function:

GetDestNetworkPrefix()

Ipv6Prefix ns3::Ipv6RoutingTableEntry::GetDestNetworkPrefix

(

)

const

Get the destination prefix.

Returns

the destination prefix

Definition at line 153 of file ipv6-routing-table-entry.cc.

References m_destNetworkPrefix.

Referenced by ns3::Ipv6StaticRouting::GetDefaultRoute(), ns3::Ipv6StaticRouting::HasNetworkDest(), ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupRoute(), ns3::Ipv6StaticRouting::LookupStatic(), ns3::Ipv6StaticRouting::NotifyRemoveRoute(), ns3::operator<<(), ns3::Ipv6StaticRouting::PrintRoutingTable(), and ns3::RipNg::PrintRoutingTable().

Here is the caller graph for this function:

GetGateway()

Ipv6Address ns3::Ipv6RoutingTableEntry::GetGateway

(

)

const

Get the gateway.

Returns

the IPv6 address of the gateway

Definition at line 165 of file ipv6-routing-table-entry.cc.

References m_gateway.

Referenced by ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupRoute(), ns3::Ipv6StaticRouting::LookupStatic(), ns3::operator<<(), ns3::Ipv6StaticRouting::PrintRoutingTable(), ns3::RipNg::PrintRoutingTable(), and StackHelper::PrintRoutingTable().

Here is the caller graph for this function:

GetInterface()

uint32_t ns3::Ipv6RoutingTableEntry::GetInterface

(

)

const

Get the interface index.

Returns

the index of the interface

Definition at line 219 of file ipv6-routing-table-entry.cc.

References m_interface.

Referenced by ns3::Ipv6StaticRouting::HasNetworkDest(), ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupRoute(), ns3::Ipv6StaticRouting::LookupStatic(), ns3::Ipv6StaticRouting::NotifyRemoveRoute(), ns3::operator<<(), ns3::Ipv6StaticRouting::PrintRoutingTable(), ns3::RipNg::PrintRoutingTable(), StackHelper::PrintRoutingTable(), and ns3::Ipv6StaticRouting::RemoveRoute().

Here is the caller graph for this function:

GetPrefixToUse()

Ipv6Address ns3::Ipv6RoutingTableEntry::GetPrefixToUse

(

)

const

Get the prefix to use (for multihomed link).

Returns

prefix address to use

Definition at line 123 of file ipv6-routing-table-entry.cc.

References m_prefixToUse.

Referenced by ns3::RipNg::Lookup(), ns3::Ipv6StaticRouting::LookupRoute(), ns3::Ipv6StaticRouting::LookupStatic(), StackHelper::PrintRoutingTable(), and ns3::Ipv6StaticRouting::RemoveRoute().

Here is the caller graph for this function:

IsDefault()

bool ns3::Ipv6RoutingTableEntry::IsDefault

(

)

const

Is it the default route ?

Returns

true if this route is a default route, false otherwise

Definition at line 141 of file ipv6-routing-table-entry.cc.

References ns3::Ipv6Address::GetZero(), and m_dest.

Referenced by ns3::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

IsGateway()

bool ns3::Ipv6RoutingTableEntry::IsGateway

(

)

const

Is it the gateway ?

Returns

true if this route is a gateway, false otherwise

Definition at line 159 of file ipv6-routing-table-entry.cc.

References ns3::Ipv6Address::GetZero(), and m_gateway.

Referenced by ns3::operator<<(), ns3::Ipv6StaticRouting::PrintRoutingTable(), and ns3::RipNg::PrintRoutingTable().

Here is the call graph for this function:

Here is the caller graph for this function:

IsHost()

bool ns3::Ipv6RoutingTableEntry::IsHost

(

)

const

Is the route entry correspond to a host ?

Returns

true if the route is a host, false otherwise

Definition at line 111 of file ipv6-routing-table-entry.cc.

References ns3::Ipv6Prefix::GetOnes(), and m_destNetworkPrefix.

Referenced by IsNetwork(), ns3::operator<<(), ns3::Ipv6StaticRouting::PrintRoutingTable(), and ns3::RipNg::PrintRoutingTable().

Here is the call graph for this function:

Here is the caller graph for this function:

IsNetwork()

bool ns3::Ipv6RoutingTableEntry::IsNetwork

(

)

const

Is the route entry correspond to a network ?

Returns

true if the route is a network, false otherwise

Definition at line 135 of file ipv6-routing-table-entry.cc.

References IsHost().

Referenced by ns3::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

SetPrefixToUse()

void ns3::Ipv6RoutingTableEntry::SetPrefixToUse

(

Ipv6Address

prefix

)

Set the prefix to use.

Parameters

prefix

prefix to use

Definition at line 129 of file ipv6-routing-table-entry.cc.

References m_prefixToUse.

Member Data Documentation

m_dest

Ipv6Address ns3::Ipv6RoutingTableEntry::m_dest

private

IPv6 address of the destination.

Definition at line 250 of file ipv6-routing-table-entry.h.

Referenced by Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), GetDest(), GetDestNetwork(), and IsDefault().

m_destNetworkPrefix

Ipv6Prefix ns3::Ipv6RoutingTableEntry::m_destNetworkPrefix

private

IPv6 prefix of the destination.

Definition at line 255 of file ipv6-routing-table-entry.h.

Referenced by Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), GetDestNetworkPrefix(), and IsHost().

m_gateway

Ipv6Address ns3::Ipv6RoutingTableEntry::m_gateway

private

IPv6 address of the gateway.

Definition at line 260 of file ipv6-routing-table-entry.h.

Referenced by Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), GetGateway(), and IsGateway().

m_interface

uint32_t ns3::Ipv6RoutingTableEntry::m_interface

private

The interface index.

Definition at line 265 of file ipv6-routing-table-entry.h.

Referenced by Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), and GetInterface().

m_prefixToUse

Ipv6Address ns3::Ipv6RoutingTableEntry::m_prefixToUse

private

Prefix to use.

Definition at line 270 of file ipv6-routing-table-entry.h.

Referenced by Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), Ipv6RoutingTableEntry(), GetPrefixToUse(), and SetPrefixToUse().

---

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

• src/internet/model/ipv6-routing-table-entry.h
• src/internet/model/ipv6-routing-table-entry.cc