ns3::Radvd Class Reference

Router advertisement daemon. More...

#include <introspected-doxygen.h>

Inheritance diagram for ns3::Radvd:

Public Member Functions
	Radvd ()
	Constructor.
virtual	~Radvd ()
	Destructor.
void	AddConfiguration (Ptr< RadvdInterface > routerInterface)
	Add configuration for an interface;. More...
int64_t	AssignStreams (int64_t stream)
Public Member Functions inherited from ns3::Application
Ptr< Node >	GetNode () const
void	SetNode (Ptr< Node > node)
void	SetStartTime (Time start)
	Specify application start time. More...
void	SetStopTime (Time stop)
	Specify application stop time. More...
Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
AggregateIterator	GetAggregateIterator (void) const
virtual TypeId	GetInstanceTypeId (void) const
template<typename T >
Ptr< T >	GetObject (void) const
template<typename T >
Ptr< T >	GetObject (TypeId tid) const
void	Initialize (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const
bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void	SetAttribute (std::string name, const AttributeValue &value)
bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)
	Get the type ID. More...
Static Public Member Functions inherited from ns3::Application
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Static Public Attributes
static const uint32_t	MAX_RA_DELAY_TIME = 500
	Default value for maximum delay of RA (ms)

Protected Member Functions
virtual void	DoDispose ()
	Dispose the instance.
Protected Member Functions inherited from ns3::Application
virtual void	DoInitialize (void)
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	NotifyNewAggregate (void)
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Private Types
typedef std::map< uint32_t, EventId >	EventIdMap
typedef std::map< uint32_t, EventId >::const_iterator	EventIdMapCI
typedef std::map< uint32_t, EventId >::iterator	EventIdMapI
typedef std::list< Ptr < RadvdInterface > >	RadvdInterfaceList
typedef std::list< Ptr < RadvdInterface > >::const_iterator	RadvdInterfaceListCI
typedef std::list< Ptr < RadvdInterface > >::iterator	RadvdInterfaceListI

Private Member Functions
void	HandleRead (Ptr< Socket > socket)
	Handle received packet, especially router solicitation. More...
void	ScheduleTransmit (Time dt, Ptr< RadvdInterface > config, EventId &eventId, Ipv6Address dst=Ipv6Address::GetAllNodesMulticast(), bool reschedule=false)
	Schedule sending a packet. More...
void	Send (Ptr< RadvdInterface > config, Ipv6Address dst=Ipv6Address::GetAllNodesMulticast(), bool reschedule=false)
	Send a packet. More...
virtual void	StartApplication ()
	Start the application.
virtual void	StopApplication ()
	Stop the application.

Private Attributes
RadvdInterfaceList	m_configurations
	List of configuration for interface.
EventIdMap	m_eventIds
	Event ID map.
Ptr< UniformRandomVariable >	m_jitter
	Variable to provide jitter in advertisement interval.
Ptr< Socket >	m_socket
	Raw socket to send RA.

Additional Inherited Members
Protected Attributes inherited from ns3::Application
Ptr< Node >	m_node
EventId	m_startEvent
Time	m_startTime
EventId	m_stopEvent
Time	m_stopTime

Detailed Description

Router advertisement daemon.

Config Paths

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

• /NodeList/[i]/ApplicationList/[i]/$ns3::Radvd

Attributes

• AdvertisementJitter: Uniform variable to provide jitter between min and max values of AdvInterval
  • Set with class: ns3::PointerValue
  • Underlying type: ns3::Ptr< ns3::UniformRandomVariable >
  • Initial value: ns3::UniformRandomVariable
  • Flags: construct write read

Attributes defined in parent class ns3::Application

• StartTime: Time at which the application will start
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: +0.0ns
  • Flags: construct write read
• StopTime: Time at which the application will stop
  • Set with class: TimeValue
  • Underlying type: Time
  • Initial value: +0.0ns
  • Flags: construct write read

No TraceSources are defined for this type.

Definition at line 47 of file radvd.h.

Member Function Documentation

void ns3::Radvd::AddConfiguration

(

Ptr< RadvdInterface >

routerInterface

)

Add configuration for an interface;.

Parameters

routerInterface

configuration

Definition at line 123 of file radvd.cc.

References m_configurations, and NS_LOG_FUNCTION.

int64_t ns3::Radvd::AssignStreams

(

int64_t

stream

)

Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

Parameters

stream

first stream index to use

Returns

the number of stream indices assigned by this model

Definition at line 130 of file radvd.cc.

References m_jitter, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().

TypeId ns3::Radvd::GetTypeId ( void  )

static

Get the type ID.

Returns

type ID

Definition at line 47 of file radvd.cc.

References m_jitter, and ns3::TypeId::SetParent().

void ns3::Radvd::HandleRead ( Ptr< Socket >  socket )

private

Handle received packet, especially router solicitation.

Parameters

socket

socket to read data from

Definition at line 246 of file radvd.cc.

References ns3::Inet6SocketAddress::ConvertFrom(), ns3::Packet::CopyData(), ns3::Icmpv6Header::GetCode(), ns3::Inet6SocketAddress::GetIpv6(), ns3::Ipv6Header::GetSourceAddress(), ns3::Time::GetTimeStep(), ns3::UniformRandomVariable::GetValue(), ns3::Inet6SocketAddress::IsMatchingType(), m_configurations, m_eventIds, m_jitter, MAX_RA_DELAY_TIME, ns3::MilliSeconds(), ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Socket::RecvFrom(), ns3::Packet::RemoveHeader(), and ScheduleTransmit().

Referenced by StartApplication().

void ns3::Radvd::ScheduleTransmit ( Time  dt, Ptr< RadvdInterface >  config, EventId &  eventId, Ipv6Address  dst = Ipv6Address::GetAllNodesMulticast (), bool  reschedule = false  )

private

Schedule sending a packet.

Parameters

dt	interval between packet
config	interface configuration
eventId	event ID associated
dst	IPv6 destination address
reschedule	if true another send will be reschedule (periodic)

Definition at line 137 of file radvd.cc.

References NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and Send().

Referenced by HandleRead(), Send(), and StartApplication().

void ns3::Radvd::Send ( Ptr< RadvdInterface >  config, Ipv6Address  dst = Ipv6Address::GetAllNodesMulticast (), bool  reschedule = false  )

private

Send a packet.

Parameters

config	interface configuration
dst	destination address (default ff02::1)
reschedule	if true another send will be reschedule (periodic)

Definition at line 143 of file radvd.cc.

References ns3::Packet::AddHeader(), ns3::Packet::AddPacketTag(), ns3::Socket::Bind(), ns3::Socket::Connect(), ns3::Ipv6Address::GetAllNodesMulticast(), ns3::RadvdInterface::GetCurHopLimit(), ns3::RadvdInterface::GetDefaultLifeTime(), ns3::RadvdInterface::GetInterface(), ns3::RadvdInterface::GetLinkMtu(), ns3::RadvdInterface::GetMaxRtrAdvInterval(), ns3::RadvdInterface::GetMinRtrAdvInterval(), ns3::Application::GetNode(), ns3::Object::GetObject(), ns3::RadvdInterface::GetPrefixes(), ns3::RadvdInterface::GetReachableTime(), ns3::RadvdInterface::GetRetransTimer(), ns3::Packet::GetSize(), ns3::UniformRandomVariable::GetValue(), ns3::RadvdInterface::IsHomeAgentFlag(), ns3::RadvdInterface::IsManagedFlag(), ns3::RadvdInterface::IsOtherConfigFlag(), ns3::RadvdInterface::IsSourceLLAddress(), m_eventIds, m_jitter, m_socket, ns3::MilliSeconds(), NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, NS_LOG_LOGIC, ScheduleTransmit(), ns3::Socket::Send(), ns3::Icmpv6OptionPrefixInformation::SetFlags(), ns3::Icmpv6OptionPrefixInformation::SetPreferredTime(), ns3::Icmpv6OptionPrefixInformation::SetPrefix(), ns3::Icmpv6OptionPrefixInformation::SetPrefixLength(), and ns3::Icmpv6OptionPrefixInformation::SetValidTime().

Referenced by ScheduleTransmit().

---

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

• src/applications/model/radvd.h
• src/applications/model/radvd.cc