ns3::Ipv6AutoconfiguredPrefix Class Reference

Router prefix information. More...

#include <ipv6-autoconfigured-prefix.h>

Inheritance diagram for ns3::Ipv6AutoconfiguredPrefix:

Collaboration diagram for ns3::Ipv6AutoconfiguredPrefix:

List of all members.

Public Member Functions
	Ipv6AutoconfiguredPrefix (Ptr< Node > node, uint32_t interface, Ipv6Address prefix, Ipv6Prefix mask, uint32_t preferredLifeTime, uint32_t validLifeTime, Ipv6Address router=Ipv6Address("::"))
	Constructor.
	~Ipv6AutoconfiguredPrefix ()
	Destructor.
void	SetDefaultGatewayRouter (Ipv6Address router)
	Set the default gateway router.
Ipv6Address	GetDefaultGatewayRouter () const
	Get the default gateway address.
uint32_t	GetInterface () const
	Get the interface index.
void	SetInterface (uint32_t interface)
	Set the interface.
uint32_t	GetPreferredLifeTime () const
	Get the prefix preferred life time.
void	SetPreferredLifeTime (uint32_t p)
	Set the prefix preferred life time.
uint32_t	GetValidLifeTime (void) const
	Get the prefix valid life time.
void	SetValidLifeTime (uint32_t v)
	Set the prefix valid life time.
bool	IsPreferred () const
	Test if the prefix is preferred.
bool	IsValid () const
	Test if the prefix is valid.
void	SetPreferred ()
	Set the prefix as preferred.
void	SetValid ()
	Set the prefix as valid.
void	StartPreferredTimer ()
	Start the preferred timer.
void	StartValidTimer ()
	Start the valid timer.
void	StopPreferredTimer ()
	Stop the preferred timer.
void	StopValidTimer ()
	Stop the valid timer.
void	MarkPreferredTime ()
	Set the prefix as preferred.
void	MarkValidTime ()
	Set the prefix as valid.
void	FunctionPreferredTimeout ()
	Signal that the preferred time expired and start the valid timer.
void	FunctionValidTimeout ()
	Signal that the valid time expired.
void	RemoveMe ()
	Remove this prefix from the prefix list.
uint32_t	GetId () const
	Get the prefix identifier.
Ipv6Address	GetPrefix () const
	Get the prefix address.
void	SetPrefix (Ipv6Address prefix)
	Set the prefix address.
Ipv6Prefix	GetMask () const
	Get the bitmask prefix.
void	SetMask (Ipv6Prefix mask)
	Set the bitmask prefix.

---

Detailed Description

Router prefix information.

---

Constructor & Destructor Documentation

ns3::Ipv6AutoconfiguredPrefix::Ipv6AutoconfiguredPrefix	(	Ptr< Node >	node,
		uint32_t	interface,
		Ipv6Address	prefix,
		Ipv6Prefix	mask,
		uint32_t	preferredLifeTime,
		uint32_t	validLifeTime,
		Ipv6Address	router = Ipv6Address ("::")
	)

Constructor.

Parameters:

node	node
interface	interface index
prefix	IPv6 address
mask	bitmask prefix
preferredLifeTime	the preferred life time
validLifeTime	the valid life time
router	if it the prefix that configure the default gateway

---

Member Function Documentation

Ipv6Address ns3::Ipv6AutoconfiguredPrefix::GetDefaultGatewayRouter

(

)

const

Get the default gateway address.

Returns:

IPv6 link-local address of the default router

uint32_t ns3::Ipv6AutoconfiguredPrefix::GetId

(

)

const

Get the prefix identifier.

Returns:

id of the prefix.

uint32_t ns3::Ipv6AutoconfiguredPrefix::GetInterface

(

void

)

const

Get the interface index.

Returns:

interface index

Ipv6Prefix ns3::Ipv6AutoconfiguredPrefix::GetMask

(

void

)

const

Get the bitmask prefix.

Returns:

bitmask prefix

uint32_t ns3::Ipv6AutoconfiguredPrefix::GetPreferredLifeTime

(

)

const

Get the prefix preferred life time.

Returns:

preferred life time

Ipv6Address ns3::Ipv6AutoconfiguredPrefix::GetPrefix

(

)

const

Get the prefix address.

Returns:

prefix address

uint32_t ns3::Ipv6AutoconfiguredPrefix::GetValidLifeTime

(

void

)

const

Get the prefix valid life time.

Returns:

valid life time

bool ns3::Ipv6AutoconfiguredPrefix::IsPreferred

(

)

const

Test if the prefix is preferred.

Returns:

true if prefix is in preferred state, false otherwise

bool ns3::Ipv6AutoconfiguredPrefix::IsValid

(

)

const

Test if the prefix is valid.

Returns:

true if prefix is in valid state, false otherwise

void ns3::Ipv6AutoconfiguredPrefix::SetDefaultGatewayRouter

(

Ipv6Address

router

)

Set the default gateway router.

Parameters:

router

IPv6 link-local address of the default router

void ns3::Ipv6AutoconfiguredPrefix::SetInterface

(

uint32_t

interface

)

Set the interface.

Parameters:

interface

interface index to set

void ns3::Ipv6AutoconfiguredPrefix::SetMask

(

Ipv6Prefix

mask

)

Set the bitmask prefix.

Parameters:

mask

prefix

void ns3::Ipv6AutoconfiguredPrefix::SetPreferredLifeTime

(

uint32_t

p

)

Set the prefix preferred life time.

Parameters:

p	the prefix preferred life time

void ns3::Ipv6AutoconfiguredPrefix::SetPrefix

(

Ipv6Address

prefix

)

Set the prefix address.

Parameters:

prefix

prefix address to set

void ns3::Ipv6AutoconfiguredPrefix::SetValidLifeTime

(

uint32_t

v

)

Set the prefix valid life time.

Parameters:

v	the prefix valid life time

---

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

• src/internet/model/ipv6-autoconfigured-prefix.h
• src/internet/model/ipv6-autoconfigured-prefix.cc