ns-3
ns3::RadvdInterface Class Reference

Radvd interface configuration. More...

#include <radvd-interface.h>

Inheritance diagram for ns3::RadvdInterface:
Collaboration diagram for ns3::RadvdInterface:

List of all members.

Public Member Functions

 RadvdInterface (uint32_t interface)
 Constructor.
 RadvdInterface (uint32_t interface, uint32_t maxRtrAdvInterval, uint32_t minRtrAdvInterval)
 Constructor.
 ~RadvdInterface ()
 Destructor.
uint32_t GetInterface () const
 Get interface index for this configuration.
std::list< Ptr< RadvdPrefix > > GetPrefixes () const
 Get list of prefixes advertised for this interface.
void AddPrefix (Ptr< RadvdPrefix > routerPrefix)
 Add a prefix to advertise on interface.
bool IsSendAdvert () const
 Is send advert enabled (periodic RA and reply to RS) ?
void SetSendAdvert (bool sendAdvert)
 Set send advert flag.
uint32_t GetMaxRtrAdvInterval () const
 Get maximum RA interval.
void SetMaxRtrAdvInterval (uint32_t maxRtrAdvInterval)
 Get maximum RA interval.
uint32_t GetMinRtrAdvInterval () const
 Get minimum RA interval.
void SetMinRtrAdvInterval (uint32_t minRtrAdvInterval)
 Get minimum RA interval.
uint32_t GetMinDelayBetweenRAs () const
 Get minimum delay between RAs.
void SetMinDelayBetweenRAs (uint32_t minDelayBetweenRAs)
 Set minimum delay between RAs.
bool IsManagedFlag () const
 Is managed flag enabled ?
void SetManagedFlag (bool managedFlag)
 Set managed flag.
bool IsOtherConfigFlag () const
 Is "other config" flag enabled ?
void SetOtherConfigFlag (bool otherConfigFlag)
 Set "other config" flag.
uint32_t GetLinkMtu () const
 Get link MTU.
void SetLinkMtu (uint32_t linkMtu)
 Set link MTU.
uint32_t GetReachableTime () const
 Get reachable time.
void SetReachableTime (uint32_t reachableTime)
 Set reachable time.
uint32_t GetDefaultLifeTime () const
 Get default lifetime.
void SetDefaultLifeTime (uint32_t defaultLifeTime)
 Set default lifetime.
uint32_t GetRetransTimer () const
 Get retransmission timer.
void SetRetransTimer (uint32_t retransTimer)
 Set retransmission timer.
uint8_t GetCurHopLimit () const
 Get current hop limit.
void SetCurHopLimit (uint8_t curHopLimit)
 Set current hop limit.
uint8_t GetDefaultPreference () const
 Get default preference.
void SetDefaultPreference (uint8_t defaultPreference)
 Set default preference.
bool IsSourceLLAddress () const
 Is source LLA option should be included in RA ?
void SetSourceLLAddress (bool sourceLLAddress)
 Set flag to add or not LLA to RA.
bool IsHomeAgentFlag () const
 Is "home agent" flag enabled ?
void SetHomeAgentFlag (bool homeAgentFlag)
 Set "home agent" flag.
bool IsHomeAgentInfo () const
 Is Home Agent Information option should be included in RA ?
void SetHomeAgentInfo (bool homeAgentFlag)
 Set flag to add or not HA information option to RA.
uint32_t GetHomeAgentLifeTime () const
 Get home agent lifetime.
void SetHomeAgentLifeTime (uint32_t homeAgentLifeTime)
 Set home agent lifetime.
uint32_t GetHomeAgentPreference () const
 Get home agent preference.
void SetHomeAgentPreference (uint32_t homeAgentPreference)
 Set home agent preference.
bool IsMobRtrSupportFlag () const
 Is "mobile router support" flag enabled ?
void SetMobRtrSupportFlag (bool mobRtrSupportFlag)
 Set "mobile router support" flag.
bool IsIntervalOpt () const
 Is advertisement interval option should be included in RA ?
void SetIntervalOpt (bool intervalOpt)
 Set flag to add or not advertisement interval to RA.

Detailed Description

Radvd interface configuration.


Constructor & Destructor Documentation

ns3::RadvdInterface::RadvdInterface ( uint32_t  interface)

Constructor.

Parameters:
interfaceinterface index
ns3::RadvdInterface::RadvdInterface ( uint32_t  interface,
uint32_t  maxRtrAdvInterval,
uint32_t  minRtrAdvInterval 
)

Constructor.

Parameters:
interfaceinterface index
maxRtrAdvIntervalmaximum RA interval (ms)
minRtrAdvIntervalminimum RA interval (ms)

References NS_ASSERT.


Member Function Documentation

void ns3::RadvdInterface::AddPrefix ( Ptr< RadvdPrefix routerPrefix)

Add a prefix to advertise on interface.

Parameters:
routerPrefixprefix to advertise

Get current hop limit.

Returns:
current hop limit for the link

Get default lifetime.

Returns:
default lifetime

Get default preference.

Returns:
default preference

Get home agent lifetime.

Returns:
home agent lifetime

Get home agent preference.

Returns:
home agent preference

Get interface index for this configuration.

Returns:
interface index
uint32_t ns3::RadvdInterface::GetLinkMtu ( ) const

Get link MTU.

Returns:
link MTU

Get maximum RA interval.

Returns:
RA interval (ms)

Get minimum delay between RAs.

Returns:
minimum delay (ms)

Get minimum RA interval.

Returns:
RA interval (ms)

Get list of prefixes advertised for this interface.

Returns:
list of IPv6 prefixes

Get reachable time.

Returns:
reachable time

Get retransmission timer.

Returns:
retransmission timer

Is "home agent" flag enabled ?

Returns:
"home agent" flag

Is Home Agent Information option should be included in RA ?

Returns:
true if HA information option is added in RA, false otherwise

Is advertisement interval option should be included in RA ?

Returns:
true if advertisement interval option is added in RA, false otherwise

Is managed flag enabled ?

Returns:
managed flag

Is "mobile router support" flag enabled ?

Returns:
"mobile router support" flag

Is "other config" flag enabled ?

Returns:
other config flag

Is send advert enabled (periodic RA and reply to RS) ?

Returns:
send advert flag

Is source LLA option should be included in RA ?

Returns:
true if source address is added in RA, false otherwise
void ns3::RadvdInterface::SetCurHopLimit ( uint8_t  curHopLimit)

Set current hop limit.

Parameters:
curHopLimitcurrent hop limit for the link
void ns3::RadvdInterface::SetDefaultLifeTime ( uint32_t  defaultLifeTime)

Set default lifetime.

Parameters:
defaultLifeTimedefault lifetime
void ns3::RadvdInterface::SetDefaultPreference ( uint8_t  defaultPreference)

Set default preference.

Parameters:
defaultPreferencedefault preference
void ns3::RadvdInterface::SetHomeAgentFlag ( bool  homeAgentFlag)

Set "home agent" flag.

Parameters:
homeAgentFlagvalue
void ns3::RadvdInterface::SetHomeAgentInfo ( bool  homeAgentFlag)

Set flag to add or not HA information option to RA.

Parameters:
homeAgentFlagvalue
void ns3::RadvdInterface::SetHomeAgentLifeTime ( uint32_t  homeAgentLifeTime)

Set home agent lifetime.

Parameters:
homeAgentLifeTimehome agent lifetime
void ns3::RadvdInterface::SetHomeAgentPreference ( uint32_t  homeAgentPreference)

Set home agent preference.

Parameters:
homeAgentPreferencehome agent preference
void ns3::RadvdInterface::SetIntervalOpt ( bool  intervalOpt)

Set flag to add or not advertisement interval to RA.

Parameters:
intervalOptvalue
void ns3::RadvdInterface::SetLinkMtu ( uint32_t  linkMtu)

Set link MTU.

Parameters:
linkMtulink MTU
void ns3::RadvdInterface::SetManagedFlag ( bool  managedFlag)

Set managed flag.

Parameters:
managedFlagvalue
void ns3::RadvdInterface::SetMaxRtrAdvInterval ( uint32_t  maxRtrAdvInterval)

Get maximum RA interval.

Parameters:
maxRtrAdvIntervalRA interval (ms)
void ns3::RadvdInterface::SetMinDelayBetweenRAs ( uint32_t  minDelayBetweenRAs)

Set minimum delay between RAs.

Parameters:
minDelayBetweenRAsminimum delay (ms)
void ns3::RadvdInterface::SetMinRtrAdvInterval ( uint32_t  minRtrAdvInterval)

Get minimum RA interval.

Parameters:
minRtrAdvIntervalRA interval (ms).
void ns3::RadvdInterface::SetMobRtrSupportFlag ( bool  mobRtrSupportFlag)

Set "mobile router support" flag.

Parameters:
mobRtrSupportFlagvalue
void ns3::RadvdInterface::SetOtherConfigFlag ( bool  otherConfigFlag)

Set "other config" flag.

Parameters:
otherConfigFlagvalue
void ns3::RadvdInterface::SetReachableTime ( uint32_t  reachableTime)

Set reachable time.

Parameters:
reachableTimereachable time
void ns3::RadvdInterface::SetRetransTimer ( uint32_t  retransTimer)

Set retransmission timer.

Parameters:
retransTimerretransmission timer
void ns3::RadvdInterface::SetSendAdvert ( bool  sendAdvert)

Set send advert flag.

Parameters:
sendAdvertvalue
void ns3::RadvdInterface::SetSourceLLAddress ( bool  sourceLLAddress)

Set flag to add or not LLA to RA.

Parameters:
sourceLLAddressvalue

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