A Discrete-Event Network Simulator
API
ns3::Ipv6Interface Class Reference

The IPv6 representation of a network interface. More...

#include "ipv6-interface.h"

+ Inheritance diagram for ns3::Ipv6Interface:
+ Collaboration diagram for ns3::Ipv6Interface:

Public Member Functions

 Ipv6Interface ()
 Constructs an Ipv6Interface. More...
 
 Ipv6Interface (const Ipv6Interface &)=delete
 
virtual ~Ipv6Interface ()
 Destructor. More...
 
bool AddAddress (Ipv6InterfaceAddress iface)
 Add an IPv6 address. More...
 
Ipv6InterfaceAddress GetAddress (uint32_t index) const
 Get an address from IPv6 interface. More...
 
Ipv6InterfaceAddress GetAddressMatchingDestination (Ipv6Address dst)
 Get an address which is in the same network prefix as destination. More...
 
uint16_t GetBaseReachableTime () const
 Get the base reachable time. More...
 
uint8_t GetCurHopLimit () const
 Get the current hop limit value. More...
 
virtual Ptr< NetDeviceGetDevice () const
 Get the NetDevice. More...
 
Ipv6InterfaceAddress GetLinkLocalAddress () const
 Get link-local address from IPv6 interface. More...
 
uint16_t GetMetric () const
 Get the metric. More...
 
uint32_t GetNAddresses (void) const
 Get number of addresses on this IPv6 interface. More...
 
Ptr< NdiscCacheGetNdiscCache () const
 
uint16_t GetReachableTime () const
 Get the reachable time. More...
 
uint16_t GetRetransTimer () const
 Get the retransmission timer. More...
 
bool IsDown () const
 Is the interface DOWN ? More...
 
bool IsForwarding () const
 If the interface allows forwarding packets. More...
 
bool IsSolicitedMulticastAddress (Ipv6Address address) const
 Checks if the address is a Solicited Multicast address for this interface. More...
 
bool IsUp () const
 Is the interface UP ? More...
 
Ipv6Interfaceoperator= (const Ipv6Interface &)=delete
 
Ipv6InterfaceAddress RemoveAddress (Ipv6Address address)
 Remove the given Ipv6 address from the interface. More...
 
Ipv6InterfaceAddress RemoveAddress (uint32_t index)
 Remove an address from interface. More...
 
void Send (Ptr< Packet > p, const Ipv6Header &hdr, Ipv6Address dest)
 Send a packet through this interface. More...
 
void SetBaseReachableTime (uint16_t baseReachableTime)
 Set the base reachable time. More...
 
void SetCurHopLimit (uint8_t curHopLimit)
 Set the current hop limit. More...
 
void SetDevice (Ptr< NetDevice > device)
 Set the NetDevice. More...
 
void SetDown ()
 Disable this interface. More...
 
void SetForwarding (bool forward)
 Set forwarding enabled or not. More...
 
void SetMetric (uint16_t metric)
 Set the metric. More...
 
void SetNode (Ptr< Node > node)
 Set node associated with interface. More...
 
void SetNsDadUid (Ipv6Address address, uint32_t uid)
 Update NS DAD packet UID of an interface address. More...
 
void SetReachableTime (uint16_t reachableTime)
 Set the reachable time. More...
 
void SetRetransTimer (uint16_t retransTimer)
 Set the retransmission timer. More...
 
void SetState (Ipv6Address address, Ipv6InterfaceAddress::State_e state)
 Update state of an interface address. More...
 
void SetTrafficControl (Ptr< TrafficControlLayer > tc)
 Set the TrafficControlLayer. More...
 
void SetUp ()
 Enable this interface. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Protected Member Functions

virtual void DoDispose ()
 Dispose this object. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Private Types

typedef std::list< std::pair< Ipv6InterfaceAddress, Ipv6Address > > Ipv6InterfaceAddressList
 Container for the Ipv6InterfaceAddresses. More...
 
typedef std::list< std::pair< Ipv6InterfaceAddress, Ipv6Address > >::const_iterator Ipv6InterfaceAddressListCI
 Const Container Iterator for the Ipv6InterfaceAddresses. More...
 
typedef std::list< std::pair< Ipv6InterfaceAddress, Ipv6Address > >::iterator Ipv6InterfaceAddressListI
 Container Iterator for the Ipv6InterfaceAddresses. More...
 

Private Member Functions

void DoSetup ()
 Initialize interface. More...
 

Private Attributes

Ipv6InterfaceAddressList m_addresses
 The addresses assigned to this interface. More...
 
uint16_t m_baseReachableTime
 Base value used for computing the random reachable time value (in millisecond). More...
 
uint8_t m_curHopLimit
 Current hop limit. More...
 
Ptr< NetDevicem_device
 NetDevice associated with this interface. More...
 
bool m_forwarding
 Forwarding state. More...
 
bool m_ifup
 The state of this interface. More...
 
Ipv6InterfaceAddress m_linkLocalAddress
 The link-local addresses assigned to this interface. More...
 
uint16_t m_metric
 The metric. More...
 
Ptr< NdiscCachem_ndCache
 Neighbor cache. More...
 
Ptr< Nodem_node
 Node associated with this interface. More...
 
uint16_t m_reachableTime
 Reachable time (in millisecond). More...
 
uint16_t m_retransTimer
 Retransmission timer (in millisecond). More...
 
Ptr< TrafficControlLayerm_tc
 TrafficControlLayer associated with this interface. More...
 

Additional Inherited Members

Detailed Description

The IPv6 representation of a network interface.

By default IPv6 interfaces are created in the "down" state with IP "fe80::1" and a /64 prefix. Before becoming usable, the user must invoke SetUp on them once the final IPv6 address and mask has been set.

Config Paths

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

  • "/NodeList/[i]/$ns3::Ipv6L3Protocol/InterfaceList/[i]"

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 152 bytes (on a 64-bit architecture).

Definition at line 51 of file ipv6-interface.h.

Member Typedef Documentation

◆ Ipv6InterfaceAddressList

Container for the Ipv6InterfaceAddresses.

Definition at line 289 of file ipv6-interface.h.

◆ Ipv6InterfaceAddressListCI

Const Container Iterator for the Ipv6InterfaceAddresses.

Definition at line 299 of file ipv6-interface.h.

◆ Ipv6InterfaceAddressListI

Container Iterator for the Ipv6InterfaceAddresses.

Definition at line 294 of file ipv6-interface.h.

Constructor & Destructor Documentation

◆ Ipv6Interface() [1/2]

ns3::Ipv6Interface::Ipv6Interface ( )

Constructs an Ipv6Interface.

Definition at line 53 of file ipv6-interface.cc.

References NS_LOG_FUNCTION.

◆ ~Ipv6Interface()

ns3::Ipv6Interface::~Ipv6Interface ( )
virtual

Destructor.

Definition at line 69 of file ipv6-interface.cc.

◆ Ipv6Interface() [2/2]

ns3::Ipv6Interface::Ipv6Interface ( const Ipv6Interface )
delete

Member Function Documentation

◆ AddAddress()

bool ns3::Ipv6Interface::AddAddress ( Ipv6InterfaceAddress  iface)

Add an IPv6 address.

Parameters
ifaceaddress to add
Returns
true if address was added, false otherwise

Definition at line 194 of file ipv6-interface.cc.

References ns3::Icmpv6L4Protocol::DoDAD(), ns3::Icmpv6L4Protocol::FunctionDadTimeout(), ns3::Ipv6InterfaceAddress::GetAddress(), ns3::Object::GetObject(), ns3::Ipv6::GetProtocol(), ns3::Icmpv6L4Protocol::GetStaticProtocolNumber(), ns3::Ipv6Address::IsAny(), ns3::Ipv6Address::IsLocalhost(), m_addresses, m_device, m_node, ns3::Ipv6Address::MakeSolicitedAddress(), NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Seconds().

Referenced by DoSetup().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::Ipv6Interface::DoDispose ( void  )
protectedvirtual

Dispose this object.

Reimplemented from ns3::Object.

Definition at line 73 of file ipv6-interface.cc.

References ns3::Object::DoDispose(), m_device, m_ndCache, m_node, m_tc, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoSetup()

void ns3::Ipv6Interface::DoSetup ( void  )
private

Initialize interface.

Definition at line 83 of file ipv6-interface.cc.

References AddAddress(), ns3::NetDevice::GetAddress(), GetDevice(), ns3::Object::GetObject(), ns3::Ipv6::GetProtocol(), ns3::Icmpv6L4Protocol::GetStaticProtocolNumber(), m_device, m_linkLocalAddress, m_ndCache, m_node, ns3::Ipv6Address::MakeAutoconfiguredLinkLocalAddress(), and NS_LOG_FUNCTION.

Referenced by SetUp().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetAddress()

Ipv6InterfaceAddress ns3::Ipv6Interface::GetAddress ( uint32_t  index) const

Get an address from IPv6 interface.

Parameters
indexindex
Returns
Ipv6InterfaceAddress address whose index is i

Definition at line 264 of file ipv6-interface.cc.

References m_addresses, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::FunctionDadTimeout(), ns3::Ipv6L3Protocol::GetAddress(), ns3::Icmpv6L4Protocol::HandleNA(), ns3::Icmpv6L4Protocol::HandleNS(), and ns3::Ipv6L3Protocol::RemoveAutoconfiguredAddress().

+ Here is the caller graph for this function:

◆ GetAddressMatchingDestination()

Ipv6InterfaceAddress ns3::Ipv6Interface::GetAddressMatchingDestination ( Ipv6Address  dst)

Get an address which is in the same network prefix as destination.

Parameters
dstdestination address
Returns
Corresponding Ipv6InterfaceAddress or assert if not found

Definition at line 343 of file ipv6-interface.cc.

References ns3::Ipv6InterfaceAddress::GetAddress(), ns3::Ipv6InterfaceAddress::GetPrefix(), ns3::Ipv6Prefix::IsMatch(), m_addresses, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::Lookup().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetBaseReachableTime()

uint16_t ns3::Ipv6Interface::GetBaseReachableTime ( ) const

Get the base reachable time.

Returns
base reachable time

Definition at line 459 of file ipv6-interface.cc.

References m_baseReachableTime, and NS_LOG_FUNCTION.

◆ GetCurHopLimit()

uint8_t ns3::Ipv6Interface::GetCurHopLimit ( ) const

Get the current hop limit value.

Returns
current hop limit

Definition at line 447 of file ipv6-interface.cc.

References m_curHopLimit, and NS_LOG_FUNCTION.

◆ GetDevice()

◆ GetLinkLocalAddress()

Ipv6InterfaceAddress ns3::Ipv6Interface::GetLinkLocalAddress ( ) const

Get link-local address from IPv6 interface.

Returns
link-local Ipv6InterfaceAddress, assert if not found

Definition at line 240 of file ipv6-interface.cc.

References m_linkLocalAddress, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::HandleEchoRequest(), ns3::Icmpv6L4Protocol::HandleNS(), ns3::Ipv6L3Protocol::IpForward(), and ns3::Icmpv6L4Protocol::Lookup().

+ Here is the caller graph for this function:

◆ GetMetric()

uint16_t ns3::Ipv6Interface::GetMetric ( void  ) const

Get the metric.

Returns
the metric

Definition at line 144 of file ipv6-interface.cc.

References m_metric, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::GetMetric().

+ Here is the caller graph for this function:

◆ GetNAddresses()

uint32_t ns3::Ipv6Interface::GetNAddresses ( void  ) const

Get number of addresses on this IPv6 interface.

Returns
number of address

Definition at line 288 of file ipv6-interface.cc.

References m_addresses, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::FunctionDadTimeout(), ns3::Ipv6L3Protocol::GetNAddresses(), ns3::Icmpv6L4Protocol::HandleNA(), ns3::Icmpv6L4Protocol::HandleNS(), ns3::Icmpv6L4Protocol::Lookup(), and ns3::Ipv6L3Protocol::RemoveAutoconfiguredAddress().

+ Here is the caller graph for this function:

◆ GetNdiscCache()

Ptr< NdiscCache > ns3::Ipv6Interface::GetNdiscCache ( ) const
Returns
NDISC cache used by this interface

Definition at line 519 of file ipv6-interface.cc.

References m_ndCache, and NS_LOG_FUNCTION.

◆ GetReachableTime()

uint16_t ns3::Ipv6Interface::GetReachableTime ( ) const

Get the reachable time.

Returns
reachable time

Definition at line 471 of file ipv6-interface.cc.

References m_reachableTime, and NS_LOG_FUNCTION.

◆ GetRetransTimer()

uint16_t ns3::Ipv6Interface::GetRetransTimer ( ) const

Get the retransmission timer.

Returns
retransmission timer

Definition at line 483 of file ipv6-interface.cc.

References m_retransTimer, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::Ipv6Interface::GetTypeId ( void  )
static

Get the type ID.

Returns
type ID

Definition at line 44 of file ipv6-interface.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsDown()

bool ns3::Ipv6Interface::IsDown ( void  ) const

Is the interface DOWN ?

Returns
true if interface is disabled, false otherwise.

Definition at line 156 of file ipv6-interface.cc.

References m_ifup, and NS_LOG_FUNCTION.

◆ IsForwarding()

bool ns3::Ipv6Interface::IsForwarding ( void  ) const

If the interface allows forwarding packets.

Returns
true if forwarding is enabled, false otherwise

Definition at line 182 of file ipv6-interface.cc.

References m_forwarding, and NS_LOG_FUNCTION.

◆ IsSolicitedMulticastAddress()

bool ns3::Ipv6Interface::IsSolicitedMulticastAddress ( Ipv6Address  address) const

Checks if the address is a Solicited Multicast address for this interface.

Parameters
addressthe address to check.
Returns
true if it is a solicited multicast address.

Definition at line 248 of file ipv6-interface.cc.

References first::address, m_addresses, and NS_LOG_FUNCTION.

◆ IsUp()

bool ns3::Ipv6Interface::IsUp ( void  ) const

Is the interface UP ?

Returns
true if interface is enabled, false otherwise.

Definition at line 150 of file ipv6-interface.cc.

References m_ifup, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::IsUp(), Send(), and ns3::Ipv6L3Protocol::SendRealOut().

+ Here is the caller graph for this function:

◆ operator=()

Ipv6Interface& ns3::Ipv6Interface::operator= ( const Ipv6Interface )
delete

◆ RemoveAddress() [1/2]

Ipv6InterfaceAddress ns3::Ipv6Interface::RemoveAddress ( Ipv6Address  address)

Remove the given Ipv6 address from the interface.

Parameters
addressThe Ipv6 address to remove
Returns
The removed Ipv6 interface address
The null interface address if the interface did not contain the address or if loopback address was passed as argument

Definition at line 321 of file ipv6-interface.cc.

References first::address, m_addresses, NS_LOG_FUNCTION, and NS_LOG_WARN.

◆ RemoveAddress() [2/2]

Ipv6InterfaceAddress ns3::Ipv6Interface::RemoveAddress ( uint32_t  index)

Remove an address from interface.

Parameters
indexindex to remove
Returns
Ipv6InterfaceAddress address whose index is index

Definition at line 294 of file ipv6-interface.cc.

References m_addresses, NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ Send()

void ns3::Ipv6Interface::Send ( Ptr< Packet p,
const Ipv6Header hdr,
Ipv6Address  dest 
)

Send a packet through this interface.

Parameters
ppacket to send
hdrIPv6 header
destnext hop address of packet.
Note
This method will eventually call the private SendTo method which must be implemented by subclasses.
Todo:
additional checks needed here (such as whether multicast goes to loopback)?

Definition at line 362 of file ipv6-interface.cc.

References ns3::Packet::AddHeader(), ns3::NetDevice::GetBroadcast(), GetDevice(), ns3::NetDevice::GetMulticast(), ns3::Object::GetObject(), ns3::Ipv6::GetProtocol(), ns3::Icmpv6L4Protocol::GetStaticProtocolNumber(), ns3::Ipv6Address::IsMulticast(), ns3::NetDevice::IsMulticast(), IsUp(), m_addresses, m_device, m_ndCache, m_node, m_tc, ns3::NetDevice::NeedsArp(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::NetDevice::PACKET_HOST, ns3::Ipv6L3Protocol::PROT_NUMBER, and ns3::NetDevice::Send().

Referenced by ns3::Icmpv6L4Protocol::DoDAD(), ns3::Icmpv6L4Protocol::HandleNA(), ns3::Ipv6L3Protocol::ReachabilityHint(), ns3::Icmpv6L4Protocol::ReceiveLLA(), and ns3::Ipv6L3Protocol::SendRealOut().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetBaseReachableTime()

void ns3::Ipv6Interface::SetBaseReachableTime ( uint16_t  baseReachableTime)

Set the base reachable time.

Parameters
baseReachableTimethe value to set

Definition at line 453 of file ipv6-interface.cc.

References m_baseReachableTime, and NS_LOG_FUNCTION.

◆ SetCurHopLimit()

void ns3::Ipv6Interface::SetCurHopLimit ( uint8_t  curHopLimit)

Set the current hop limit.

Parameters
curHopLimitthe value to set

Definition at line 441 of file ipv6-interface.cc.

References m_curHopLimit, and NS_LOG_FUNCTION.

◆ SetDevice()

void ns3::Ipv6Interface::SetDevice ( Ptr< NetDevice device)

Set the NetDevice.

Parameters
deviceNetDevice

Definition at line 119 of file ipv6-interface.cc.

References m_device, and NS_LOG_FUNCTION.

◆ SetDown()

void ns3::Ipv6Interface::SetDown ( void  )

Disable this interface.

Definition at line 174 of file ipv6-interface.cc.

References ns3::NdiscCache::Flush(), m_addresses, m_ifup, m_ndCache, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::SetDown().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SetForwarding()

void ns3::Ipv6Interface::SetForwarding ( bool  forward)

Set forwarding enabled or not.

Parameters
forwardforwarding state

Definition at line 188 of file ipv6-interface.cc.

References m_forwarding, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::SetForwarding().

+ Here is the caller graph for this function:

◆ SetMetric()

void ns3::Ipv6Interface::SetMetric ( uint16_t  metric)

Set the metric.

Parameters
metricconfigured routing metric (cost) of this interface

Definition at line 138 of file ipv6-interface.cc.

References m_metric, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::SetMetric().

+ Here is the caller graph for this function:

◆ SetNode()

void ns3::Ipv6Interface::SetNode ( Ptr< Node node)

Set node associated with interface.

Parameters
nodenode

Definition at line 113 of file ipv6-interface.cc.

References m_node, and NS_LOG_FUNCTION.

◆ SetNsDadUid()

void ns3::Ipv6Interface::SetNsDadUid ( Ipv6Address  address,
uint32_t  uid 
)

Update NS DAD packet UID of an interface address.

Parameters
addressIPv6 address
uidpacket UID

Definition at line 504 of file ipv6-interface.cc.

References first::address, m_addresses, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::DoDAD().

+ Here is the caller graph for this function:

◆ SetReachableTime()

void ns3::Ipv6Interface::SetReachableTime ( uint16_t  reachableTime)

Set the reachable time.

Parameters
reachableTimevalue to set

Definition at line 465 of file ipv6-interface.cc.

References m_reachableTime, and NS_LOG_FUNCTION.

◆ SetRetransTimer()

void ns3::Ipv6Interface::SetRetransTimer ( uint16_t  retransTimer)

Set the retransmission timer.

Parameters
retransTimervalue to set

Definition at line 477 of file ipv6-interface.cc.

References m_retransTimer, and NS_LOG_FUNCTION.

◆ SetState()

void ns3::Ipv6Interface::SetState ( Ipv6Address  address,
Ipv6InterfaceAddress::State_e  state 
)

Update state of an interface address.

Parameters
addressIPv6 address
statenew state

Definition at line 489 of file ipv6-interface.cc.

References first::address, m_addresses, and NS_LOG_FUNCTION.

Referenced by ns3::Icmpv6L4Protocol::FunctionDadTimeout(), and ns3::Icmpv6L4Protocol::HandleNA().

+ Here is the caller graph for this function:

◆ SetTrafficControl()

void ns3::Ipv6Interface::SetTrafficControl ( Ptr< TrafficControlLayer tc)

Set the TrafficControlLayer.

Parameters
tcTrafficControlLayer object

Definition at line 126 of file ipv6-interface.cc.

References m_tc, and NS_LOG_FUNCTION.

◆ SetUp()

void ns3::Ipv6Interface::SetUp ( void  )

Enable this interface.

Definition at line 162 of file ipv6-interface.cc.

References DoSetup(), m_ifup, and NS_LOG_FUNCTION.

Referenced by ns3::Ipv6L3Protocol::SetUp().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_addresses

Ipv6InterfaceAddressList ns3::Ipv6Interface::m_addresses
private

◆ m_baseReachableTime

uint16_t ns3::Ipv6Interface::m_baseReachableTime
private

Base value used for computing the random reachable time value (in millisecond).

Definition at line 359 of file ipv6-interface.h.

Referenced by GetBaseReachableTime(), and SetBaseReachableTime().

◆ m_curHopLimit

uint8_t ns3::Ipv6Interface::m_curHopLimit
private

Current hop limit.

Definition at line 354 of file ipv6-interface.h.

Referenced by GetCurHopLimit(), and SetCurHopLimit().

◆ m_device

Ptr<NetDevice> ns3::Ipv6Interface::m_device
private

NetDevice associated with this interface.

Definition at line 339 of file ipv6-interface.h.

Referenced by AddAddress(), DoDispose(), DoSetup(), GetDevice(), Send(), and SetDevice().

◆ m_forwarding

bool ns3::Ipv6Interface::m_forwarding
private

Forwarding state.

Definition at line 324 of file ipv6-interface.h.

Referenced by IsForwarding(), and SetForwarding().

◆ m_ifup

bool ns3::Ipv6Interface::m_ifup
private

The state of this interface.

Definition at line 319 of file ipv6-interface.h.

Referenced by IsDown(), IsUp(), SetDown(), and SetUp().

◆ m_linkLocalAddress

Ipv6InterfaceAddress ns3::Ipv6Interface::m_linkLocalAddress
private

The link-local addresses assigned to this interface.

Definition at line 314 of file ipv6-interface.h.

Referenced by DoSetup(), and GetLinkLocalAddress().

◆ m_metric

uint16_t ns3::Ipv6Interface::m_metric
private

The metric.

Definition at line 329 of file ipv6-interface.h.

Referenced by GetMetric(), and SetMetric().

◆ m_ndCache

Ptr<NdiscCache> ns3::Ipv6Interface::m_ndCache
private

Neighbor cache.

Definition at line 349 of file ipv6-interface.h.

Referenced by DoDispose(), DoSetup(), GetNdiscCache(), Send(), and SetDown().

◆ m_node

Ptr<Node> ns3::Ipv6Interface::m_node
private

Node associated with this interface.

Definition at line 334 of file ipv6-interface.h.

Referenced by AddAddress(), DoDispose(), DoSetup(), Send(), and SetNode().

◆ m_reachableTime

uint16_t ns3::Ipv6Interface::m_reachableTime
private

Reachable time (in millisecond).

The time a neighbor is considered reachable after receiving a reachability confirmation.

Definition at line 365 of file ipv6-interface.h.

Referenced by GetReachableTime(), and SetReachableTime().

◆ m_retransTimer

uint16_t ns3::Ipv6Interface::m_retransTimer
private

Retransmission timer (in millisecond).

Time between retransmission of NS.

Definition at line 371 of file ipv6-interface.h.

Referenced by GetRetransTimer(), and SetRetransTimer().

◆ m_tc

Ptr<TrafficControlLayer> ns3::Ipv6Interface::m_tc
private

TrafficControlLayer associated with this interface.

Definition at line 344 of file ipv6-interface.h.

Referenced by DoDispose(), Send(), and SetTrafficControl().


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