inet::IPv6InterfaceData Class Reference

IPv6-specific data for InterfaceEntry. More...

#include <IPv6InterfaceData.h>

Inheritance diagram for inet::IPv6InterfaceData:

Classes
struct	AddressData
struct	AdvPrefix
	For routers: advertised prefix configuration. More...
struct	HomeNetworkInfo
	Zarrar 03.09.07: Home Network Information maintains home network information like the MN's home address (HoA) and the HA's address and its prefix. More...
struct	HostConstants
struct	HostMulticastData
struct	HostVariables
struct	NodeConstants
struct	NodeVariables
struct	RouterConstants
struct	RouterMulticastData
struct	RouterVariables

Public Types
enum	{ F_IP_ADDRESS, F_MULTICAST_ADDRESSES, F_MULTICAST_LISTENERS }
enum	AddressType { HoA, CoA }
	The enum AddressType defined below and the new member of the struct AddressData {AddressType addrType} is relevant for MN(s) only as the address(es) configured on the MN interface needs to be tagged as either HoA or CoA, based upon the status of the H-Flag recieved in the RA. More...
typedef std::vector< IPv6Address >	IPv6AddressVector

Public Member Functions
bool	isDADInProgress ()
void	setDADInProgress (bool val)
	IPv6InterfaceData ()
virtual	~IPv6InterfaceData ()
std::string	info () const override
std::string	detailedInfo () const override
Addresses
virtual void	assignAddress (const IPv6Address &addr, bool tentative, simtime_t expiryTime, simtime_t prefExpiryTime, bool hFlag=false)
	Assigns the given address to the interface. More...
virtual void	updateMatchingAddressExpiryTimes (const IPv6Address &prefix, int length, simtime_t expiryTime=SIMTIME_ZERO, simtime_t prefExpiryTime=SIMTIME_ZERO)
	Update expiry times of addresses. More...
int	getNumAddresses () const
	Returns the number of addresses the interface has. More...
const IPv6Address &	getAddress (int i) const
	Returns ith address of the interface. More...
bool	isTentativeAddress (int i) const
	Returns true if the ith address of the interface is tentative. More...
AddressType	getAddressType (int i) const
	Returns the address type (HoA, CoA) of the ith address of the interface. More...
AddressType	getAddressType (const IPv6Address &addr) const
	Returns the address type (HoA, CoA) of the provided address of the interface. More...
bool	hasAddress (const IPv6Address &addr) const
	Returns true if the given address is one of the addresses assigned, regardless whether it is tentative or not. More...
bool	matchesSolicitedNodeMulticastAddress (const IPv6Address &solNodeAddr) const
	Returns true if the interface has an address matching the given solicited-node multicast addresses. More...
bool	isTentativeAddress (const IPv6Address &addr) const
	Returns true if the interface has the given address and it is tentative. More...
virtual void	permanentlyAssign (const IPv6Address &addr)
	Clears the "tentative" flag of an existing interface address. More...
const IPv6AddressVector &	getJoinedMulticastGroups () const
const IPv6AddressVector &	getReportedMulticastGroups () const
bool	isMemberOfMulticastGroup (const IPv6Address &multicastAddress) const
virtual void	joinMulticastGroup (const IPv6Address &multicastAddress)
virtual void	leaveMulticastGroup (const IPv6Address &multicastAddress)
bool	hasMulticastListener (const IPv6Address &multicastAddress) const
virtual void	addMulticastListener (const IPv6Address &multicastAddress)
virtual void	removeMulticastListener (const IPv6Address &multicastAddress)
void	tentativelyAssign (int i)
	Sets the "tentative" flag of of the ith address of the interface. More...
const IPv6Address &	getPreferredAddress () const
	Chooses a preferred address for the interface and returns it. More...
const IPv6Address &	getLinkLocalAddress () const
	Returns the first valid link-local address of the interface, or UNSPECIFIED_ADDRESS if there's none. More...
virtual void	removeAddress (const IPv6Address &address)
	Removes the address. More...
simtime_t	_getMaxInitialRtrAdvertInterval () const
	Getters/Setters for all variables and constants defined in RFC 2461/2462 can be found here. More...
uint	_getMaxInitialRtrAdvertisements () const
uint	_getMaxFinalRtrAdvertisements () const
simtime_t	_getMinDelayBetweenRAs () const
simtime_t	_getMaxRADelayTime () const
virtual void	_setMaxInitialRtrAdvertInterval (simtime_t d)
virtual void	_setMaxInitialRtrAdvertisements (uint d)
virtual void	_setMaxFinalRtrAdvertisements (uint d)
virtual void	_setMinDelayBetweenRAs (simtime_t d)
virtual void	_setMaxRADelayTime (simtime_t d)
simtime_t	_getMaxRtrSolicitationDelay () const
simtime_t	_getRtrSolicitationInterval () const
uint	_getMaxRtrSolicitations () const
simtime_t	_getInitialBindAckTimeout () const
simtime_t	_getMaxBindAckTimeout () const
simtime_t	_getInitialBindAckTimeoutFirst () const
uint	_getMaxRRBindingLifeTime () const
uint	_getMaxHABindingLifeTime () const
uint	_getMaxTokenLifeTime () const
virtual void	_setMaxRtrSolicitationDelay (simtime_t d)
virtual void	_setRtrSolicitationInterval (simtime_t d)
virtual void	_setMaxRtrSolicitations (uint d)
virtual void	_setInitialBindAckTimeout (simtime_t d)
virtual void	_setMaxBindAckTimeout (simtime_t d)
virtual void	_setInitialBindAckTimeoutFirst (simtime_t d)
virtual void	_setMaxRRBindingLifeTime (uint d)
virtual void	_setMaxHABindingLifeTime (uint d)
virtual void	_setMaxTokenLifeTime (uint d)
uint	_getMaxMulticastSolicit () const
uint	_getMaxUnicastSolicit () const
simtime_t	_getMaxAnycastDelayTime () const
uint	_getMaxNeighbourAdvertisement () const
simtime_t	_getReachableTime () const
simtime_t	_getRetransTimer () const
simtime_t	_getDelayFirstProbeTime () const
double	_getMinRandomFactor () const
double	_getMaxRandomFactor () const
virtual void	_setMaxMulticastSolicit (uint d)
virtual void	_setMaxUnicastSolicit (uint d)
virtual void	_setMaxAnycastDelayTime (simtime_t d)
virtual void	_setMaxNeighbourAdvertisement (uint d)
virtual void	_setReachableTime (simtime_t d)
virtual void	_setRetransTimer (simtime_t d)
virtual void	_setDelayFirstProbeTime (simtime_t d)
virtual void	_setMinRandomFactor (double d)
virtual void	_setMaxRandomFactor (double d)
int	getDupAddrDetectTransmits () const
virtual void	setDupAddrDetectTransmits (int d)
uint	getLinkMTU () const
short	getCurHopLimit () const
uint	getBaseReachableTime () const
simtime_t	getReachableTime () const
uint	getRetransTimer () const
virtual void	setLinkMTU (uint d)
virtual void	setCurHopLimit (short d)
virtual void	setBaseReachableTime (uint d)
virtual void	setReachableTime (simtime_t d)
virtual void	setRetransTimer (uint d)
bool	getAdvSendAdvertisements () const
simtime_t	getMaxRtrAdvInterval () const
simtime_t	getMinRtrAdvInterval () const
bool	getAdvManagedFlag () const
bool	getAdvOtherConfigFlag () const
bool	getAdvHomeAgentFlag () const
int	getAdvLinkMTU () const
int	getAdvReachableTime () const
int	getAdvRetransTimer () const
short	getAdvCurHopLimit () const
simtime_t	getAdvDefaultLifetime () const
virtual void	setAdvSendAdvertisements (bool d)
virtual void	setMaxRtrAdvInterval (simtime_t d)
virtual void	setMinRtrAdvInterval (simtime_t d)
virtual void	setAdvManagedFlag (bool d)
virtual void	setAdvOtherConfigFlag (bool d)
virtual void	setAdvHomeAgentFlag (bool d)
virtual void	setAdvLinkMTU (int d)
virtual void	setAdvReachableTime (int d)
virtual void	setAdvRetransTimer (int d)
virtual void	setAdvCurHopLimit (short d)
virtual void	setAdvDefaultLifetime (simtime_t d)
Public Member Functions inherited from inet::InterfaceProtocolData
	InterfaceProtocolData ()
InterfaceEntry *	getInterfaceEntry () const
	Returns the InterfaceEntry that contains this data object, or nullptr. More...

Public Attributes
RouterConstants	routerConstants
HostConstants	hostConstants
NodeConstants	nodeConstants

Protected Types
typedef std::vector< AddressData >	AddressDataVector
typedef std::vector< AdvPrefix >	AdvPrefixList

Protected Member Functions
int	findAddress (const IPv6Address &addr) const
void	choosePreferredAddress ()
void	changed1 (int fieldId)
HostMulticastData *	getHostData ()
const HostMulticastData *	getHostData () const
RouterMulticastData *	getRouterData ()
const RouterMulticastData *	getRouterData () const
Protected Member Functions inherited from inet::InterfaceProtocolData
virtual void	changed (simsignal_t signalID, int fieldId)

Static Protected Member Functions
static bool	addrLess (const AddressData &a, const AddressData &b)

Protected Attributes
HostMulticastData *	hostMcastData = nullptr
RouterMulticastData *	routerMcastData = nullptr
HomeNetworkInfo	homeInfo
bool	dadInProgress = false
AddressDataVector	addresses
IPv6Address	preferredAddr
simtime_t	preferredAddrExpiryTime
NodeVariables	nodeVars
HostVariables	hostVars
RouterVariables	rtrVars
Protected Attributes inherited from inet::InterfaceProtocolData
InterfaceEntry *	ownerp = nullptr

Friends
std::ostream &	operator<< (std::ostream &os, const HomeNetworkInfo &homeNetInfo)

Router advertised prefixes
IPv6RoutingTable *	rt6 = nullptr
virtual void	addAdvPrefix (const AdvPrefix &advPrefix)
	Adds the given advertised prefix to the interface. More...
int	getNumAdvPrefixes () const
	Returns the number of advertised prefixes on the interface. More...
const AdvPrefix &	getAdvPrefix (int i) const
	Returns the ith advertised prefix on the interface. More...
virtual void	setAdvPrefix (int i, const AdvPrefix &advPrefix)
	Changes the configuration of the ith advertised prefix on the interface. More...
virtual void	removeAdvPrefix (int i)
	Remove the ith advertised prefix on the interface. More...
virtual simtime_t	generateReachableTime (double MIN_RANDOM_FACTOR, double MAX_RANDOM_FACTOR, uint baseReachableTime)
	This method randomly generates a reachableTime given the MIN_RANDOM_FACTOR MAX_RANDOM_FACTOR and baseReachableTime. More...
virtual simtime_t	generateReachableTime ()
	Arg-less version. More...
const IPv6Address &	getGlobalAddress (AddressType type=HoA) const
	Returns the first valid global address of the interface, or UNSPECIFIED_ADDRESS if there's none. More...
const IPv6Address	autoConfRouterGlobalScopeAddress (int i)
	This function autoconfigures a global scope address for the router only, if and only the prefix is provided via some exernal method, For instance FlatNetworkConfigurator6 assigning prefixes to routers interfaces during initialization. More...
void	autoConfRouterGlobalScopeAddress (AdvPrefix &p)
void	deduceAdvPrefix ()
void	updateHomeNetworkInfo (const IPv6Address &hoa, const IPv6Address &ha, const IPv6Address &prefix, const int prefixLength)
	03.09.07 This updates the struct HomeNetwork Info with the MN's Home Address(HoA), the global scope address of the MNs Home Agent (HA) and the home network prefix. More...
const IPv6Address &	getHomeAgentAddress () const
const IPv6Address &	getMNHomeAddress () const
const IPv6Address &	getMNPrefix () const
IPv6Address	removeAddress (IPv6InterfaceData::AddressType type)
	Removes a CoA address from the interface if one exists. More...

Detailed Description

IPv6-specific data for InterfaceEntry.

Most of this comes from section 6.2.1 of RFC 2461 (IPv6 Neighbor Discovery, Router Configuration Variables).

Member Typedef Documentation

typedef std::vector<AddressData> inet::IPv6InterfaceData::AddressDataVector

protected

typedef std::vector<AdvPrefix> inet::IPv6InterfaceData::AdvPrefixList

protected

typedef std::vector<IPv6Address> inet::IPv6InterfaceData::IPv6AddressVector

Member Enumeration Documentation

anonymous enum

Enumerator
F_IP_ADDRESS
F_MULTICAST_ADDRESSES
F_MULTICAST_LISTENERS

{ F_IP_ADDRESS, F_MULTICAST_ADDRESSES, F_MULTICAST_LISTENERS };    //FIXME missed field IDs and missed notifications in setter functions

enum inet::IPv6InterfaceData::AddressType

The enum AddressType defined below and the new member of the struct AddressData {AddressType addrType} is relevant for MN(s) only as the address(es) configured on the MN interface needs to be tagged as either HoA or CoA, based upon the status of the H-Flag recieved in the RA.

This is

Enumerator
HoA
CoA

{ HoA, CoA };    // to tag a MN's address as Home-Address or Care-of-Address. Zarrar Yousaf 20.07.07

Constructor & Destructor Documentation

inet::IPv6InterfaceData::IPv6InterfaceData

(

)

{
#ifdef WITH_xMIPv6
    // rt6 = IPv6RoutingTableAccess().get();
#endif /* WITH_xMIPv6 */
    /*******************Setting host/node/router Protocol Constants************/
    routerConstants.maxInitialRtrAdvertInterval = IPv6_MAX_INITIAL_RTR_ADVERT_INTERVAL;
    routerConstants.maxInitialRtrAdvertisements = IPv6_MAX_INITIAL_RTR_ADVERTISEMENTS;
    routerConstants.maxFinalRtrAdvertisements = IPv6_MAX_FINAL_RTR_ADVERTISEMENTS;
    routerConstants.minDelayBetweenRAs = IPv6_MIN_DELAY_BETWEEN_RAS;
    routerConstants.maxRADelayTime = IPv6_MAX_RA_DELAY_TIME;

    hostConstants.maxRtrSolicitationDelay = IPv6_MAX_RTR_SOLICITATION_DELAY;
    hostConstants.rtrSolicitationInterval = IPv6_RTR_SOLICITATION_INTERVAL;
    hostConstants.maxRtrSolicitations = IPv6_MAX_RTR_SOLICITATIONS;

#ifdef WITH_xMIPv6
    hostConstants.initialBindAckTimeout = MIPv6_INITIAL_BINDACK_TIMEOUT;    //MIPv6: added by Zarrar Yousaf @ CNI UniDo 17.06.07
    hostConstants.maxBindAckTimeout = MIPv6_MAX_BINDACK_TIMEOUT;    //MIPv6: added by Zarrar Yousaf @ CNI UniDo 17.06.07
    hostConstants.initialBindAckTimeoutFirst = MIPv6_INITIAL_BINDACK_TIMEOUT_FIRST;    //MIPv6: 12.9.07 - CB
    hostConstants.maxRRBindingLifeTime = MIPv6_MAX_RR_BINDING_LIFETIME;    // 14.9.07 - CB
    hostConstants.maxHABindingLifeTime = MIPv6_MAX_HA_BINDING_LIFETIME;    // 14.9.07 - CB
    hostConstants.maxTokenLifeTime = MIPv6_MAX_TOKEN_LIFETIME;    // 14.9.07 - CB
#endif /* WITH_xMIPv6 */

    nodeConstants.maxMulticastSolicit = IPv6_MAX_MULTICAST_SOLICIT;
    nodeConstants.maxUnicastSolicit = IPv6_MAX_UNICAST_SOLICIT;
    nodeConstants.maxAnycastDelayTime = IPv6_MAX_ANYCAST_DELAY_TIME;
    nodeConstants.maxNeighbourAdvertisement = IPv6_MAX_NEIGHBOUR_ADVERTISEMENT;
    nodeConstants.reachableTime = IPv6_REACHABLE_TIME;
    nodeConstants.retransTimer = IPv6_RETRANS_TIMER;
    nodeConstants.delayFirstProbeTime = IPv6_DELAY_FIRST_PROBE_TIME;
    nodeConstants.minRandomFactor = IPv6_MIN_RANDOM_FACTOR;
    nodeConstants.maxRandomFactor = IPv6_MAX_RANDOM_FACTOR;

    /*******************Setting host/node/router variables*********************/
    nodeVars.dupAddrDetectTransmits = IPv6_DEFAULT_DUPADDRDETECTTRANSMITS;

    hostVars.linkMTU = IPv6_MIN_MTU;
    hostVars.curHopLimit = IPv6_DEFAULT_ADVCURHOPLIMIT;    //value specified in RFC 1700-can't find it
    hostVars.baseReachableTime = IPv6_REACHABLE_TIME;
    hostVars.reachableTime = generateReachableTime(_getMinRandomFactor(),
                _getMaxRandomFactor(), getBaseReachableTime());
    hostVars.retransTimer = IPv6_RETRANS_TIMER;

    //rtrVars.advSendAdvertisements is set in IPv6RoutingTable.cc:line 143
    rtrVars.maxRtrAdvInterval = IPv6_DEFAULT_MAX_RTR_ADV_INT;
    rtrVars.minRtrAdvInterval = 0.33 * rtrVars.maxRtrAdvInterval;
    rtrVars.advManagedFlag = false;
    rtrVars.advOtherConfigFlag = false;

#ifdef WITH_xMIPv6
    rtrVars.advHomeAgentFlag = false;    //Zarrar Yousaf Feb-March 2007
#endif /* WITH_xMIPv6 */

    rtrVars.advLinkMTU = IPv6_MIN_MTU;
    rtrVars.advReachableTime = IPv6_DEFAULT_ADV_REACHABLE_TIME;
    rtrVars.advRetransTimer = IPv6_DEFAULT_ADV_RETRANS_TIMER;
    rtrVars.advCurHopLimit = IPv6_DEFAULT_ADVCURHOPLIMIT;
    rtrVars.advDefaultLifetime = 3 * rtrVars.maxRtrAdvInterval;

#if USE_MOBILITY
    if (rtrVars.advDefaultLifetime < 1)
        rtrVars.advDefaultLifetime = 1;
#endif // if USE_MOBILITY
}

inet::IPv6InterfaceData::~IPv6InterfaceData ( )

virtual

{
    delete hostMcastData;
    delete routerMcastData;
}

Member Function Documentation

simtime_t inet::IPv6InterfaceData::_getDelayFirstProbeTime ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::initiateNeighbourUnreachabilityDetection().

{ return nodeConstants.delayFirstProbeTime; }

simtime_t inet::IPv6InterfaceData::_getInitialBindAckTimeout ( ) const

inline

Referenced by inet::xMIPv6::createBUTimer(), inet::xMIPv6::createTestInitTimer(), and inet::xMIPv6::resetBUIfEntry().

{ return hostConstants.initialBindAckTimeout; }    //MIPv6: added by Zarrar Yousaf @ CNI UniDo 17.06.07

simtime_t inet::IPv6InterfaceData::_getInitialBindAckTimeoutFirst ( ) const

inline

Referenced by inet::xMIPv6::createBUTimer().

{ return hostConstants.initialBindAckTimeoutFirst; }    //MIPv6, 12.9.07 - CB

simtime_t inet::IPv6InterfaceData::_getMaxAnycastDelayTime ( ) const

inline

{ return nodeConstants.maxAnycastDelayTime; }

simtime_t inet::IPv6InterfaceData::_getMaxBindAckTimeout ( ) const

inline

Referenced by inet::xMIPv6::sendPeriodicBU(), and inet::xMIPv6::sendTestInit().

{ return hostConstants.maxBindAckTimeout; }    //MIPv6: added by Zarrar Yousaf @ CNI UniDo 17.06.07

uint inet::IPv6InterfaceData::_getMaxFinalRtrAdvertisements ( ) const

inline

{ return routerConstants.maxFinalRtrAdvertisements; }

uint inet::IPv6InterfaceData::_getMaxHABindingLifeTime ( ) const

inline

Referenced by inet::xMIPv6::createBUTimer().

{ return hostConstants.maxHABindingLifeTime; }    //MIPv6, 14.9.07 - CB

simtime_t inet::IPv6InterfaceData::_getMaxInitialRtrAdvertInterval ( ) const

inline

Getters/Setters for all variables and constants defined in RFC 2461/2462 can be found here.

Operations responsible for protocol constants are marked with a "_" prefix. Constants in this class are stored as instance variables. Default values for certain variables are defined at the top of this file, while certain variables have to be generated. Protocol constants are subject to change as specified in RFC2461:section 10 depending on different link layer operation. Getters and setters have been implemented for protocol constants so that a wireless interface may be set to a different set of constant values. (ie. changed by the FlatNetworkConfigurator) Such a design allows both wired and wireless networks to co-exist within a simulation run.

Referenced by inet::IPv6NeighbourDiscovery::sendPeriodicRA().

{ return routerConstants.maxInitialRtrAdvertInterval; }

uint inet::IPv6InterfaceData::_getMaxInitialRtrAdvertisements ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::sendPeriodicRA().

{ return routerConstants.maxInitialRtrAdvertisements; }

uint inet::IPv6InterfaceData::_getMaxMulticastSolicit ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::processARTimeout().

{ return nodeConstants.maxMulticastSolicit; }

uint inet::IPv6InterfaceData::_getMaxNeighbourAdvertisement ( ) const

inline

{ return nodeConstants.maxNeighbourAdvertisement; }

simtime_t inet::IPv6InterfaceData::_getMaxRADelayTime ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::processRSPacket().

{ return routerConstants.maxRADelayTime; }

double inet::IPv6InterfaceData::_getMaxRandomFactor ( ) const

inline

Referenced by generateReachableTime(), and IPv6InterfaceData().

{ return nodeConstants.maxRandomFactor; }

uint inet::IPv6InterfaceData::_getMaxRRBindingLifeTime ( ) const

inline

Referenced by inet::xMIPv6::createBUTimer().

{ return hostConstants.maxRRBindingLifeTime; }    //MIPv6, 14.9.07 - CB

simtime_t inet::IPv6InterfaceData::_getMaxRtrSolicitationDelay ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent(), and inet::IPv6NeighbourDiscovery::processRDTimeout().

{ return hostConstants.maxRtrSolicitationDelay; }

uint inet::IPv6InterfaceData::_getMaxRtrSolicitations ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::processRDTimeout().

{ return hostConstants.maxRtrSolicitations; }

uint inet::IPv6InterfaceData::_getMaxTokenLifeTime ( ) const

inline

Referenced by inet::BindingUpdateList::isCareOfTokenAvailable(), inet::BindingUpdateList::isHomeTokenAvailable(), inet::xMIPv6::processCoTMessage(), inet::xMIPv6::processHoTMessage(), inet::BindingUpdateList::recentlySentCOTI(), and inet::BindingUpdateList::recentlySentHOTI().

{ return hostConstants.maxTokenLifeTime; }    //MIPv6, 10.07.08 - CB

uint inet::IPv6InterfaceData::_getMaxUnicastSolicit ( ) const

inline

{ return nodeConstants.maxUnicastSolicit; }

simtime_t inet::IPv6InterfaceData::_getMinDelayBetweenRAs ( ) const

inline

{ return routerConstants.minDelayBetweenRAs; }

double inet::IPv6InterfaceData::_getMinRandomFactor ( ) const

inline

Referenced by generateReachableTime(), and IPv6InterfaceData().

{ return nodeConstants.minRandomFactor; }

simtime_t inet::IPv6InterfaceData::_getReachableTime ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::processNAForIncompleteNCEState(), and inet::IPv6NeighbourDiscovery::processNAForOtherNCEStates().

{ return nodeConstants.reachableTime; }

simtime_t inet::IPv6InterfaceData::_getRetransTimer ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::initiateAddressResolution(), and inet::IPv6NeighbourDiscovery::processARTimeout().

{ return nodeConstants.retransTimer; }

simtime_t inet::IPv6InterfaceData::_getRtrSolicitationInterval ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::initiateRouterDiscovery(), and inet::IPv6NeighbourDiscovery::processRDTimeout().

{ return hostConstants.rtrSolicitationInterval; }

virtual void inet::IPv6InterfaceData::_setDelayFirstProbeTime ( simtime_t  d )

inlinevirtual

{ nodeConstants.delayFirstProbeTime = d; }

virtual void inet::IPv6InterfaceData::_setInitialBindAckTimeout ( simtime_t  d )

inlinevirtual

{ hostConstants.initialBindAckTimeout = SIMTIME_DBL(d); }

virtual void inet::IPv6InterfaceData::_setInitialBindAckTimeoutFirst ( simtime_t  d )

inlinevirtual

{ hostConstants.initialBindAckTimeoutFirst = d; }

virtual void inet::IPv6InterfaceData::_setMaxAnycastDelayTime ( simtime_t  d )

inlinevirtual

{ nodeConstants.maxAnycastDelayTime = d; }

virtual void inet::IPv6InterfaceData::_setMaxBindAckTimeout ( simtime_t  d )

inlinevirtual

{ hostConstants.maxBindAckTimeout = SIMTIME_DBL(d); }

virtual void inet::IPv6InterfaceData::_setMaxFinalRtrAdvertisements ( uint  d )

inlinevirtual

{ routerConstants.maxFinalRtrAdvertisements = d; }

virtual void inet::IPv6InterfaceData::_setMaxHABindingLifeTime ( uint  d )

inlinevirtual

{ hostConstants.maxHABindingLifeTime = d; }

virtual void inet::IPv6InterfaceData::_setMaxInitialRtrAdvertInterval ( simtime_t  d )

inlinevirtual

{ routerConstants.maxInitialRtrAdvertInterval = d; }

virtual void inet::IPv6InterfaceData::_setMaxInitialRtrAdvertisements ( uint  d )

inlinevirtual

{ routerConstants.maxInitialRtrAdvertisements = d; }

virtual void inet::IPv6InterfaceData::_setMaxMulticastSolicit ( uint  d )

inlinevirtual

{ nodeConstants.maxMulticastSolicit = d; }

virtual void inet::IPv6InterfaceData::_setMaxNeighbourAdvertisement ( uint  d )

inlinevirtual

{ nodeConstants.maxNeighbourAdvertisement = d; }

virtual void inet::IPv6InterfaceData::_setMaxRADelayTime ( simtime_t  d )

inlinevirtual

{ routerConstants.maxRADelayTime = d; }

virtual void inet::IPv6InterfaceData::_setMaxRandomFactor ( double  d )

inlinevirtual

{ nodeConstants.maxRandomFactor = d; }

virtual void inet::IPv6InterfaceData::_setMaxRRBindingLifeTime ( uint  d )

inlinevirtual

{ hostConstants.maxRRBindingLifeTime = d; }

virtual void inet::IPv6InterfaceData::_setMaxRtrSolicitationDelay ( simtime_t  d )

inlinevirtual

{ hostConstants.maxRtrSolicitationDelay = d; }

virtual void inet::IPv6InterfaceData::_setMaxRtrSolicitations ( uint  d )

inlinevirtual

{ hostConstants.maxRtrSolicitations = d; }

virtual void inet::IPv6InterfaceData::_setMaxTokenLifeTime ( uint  d )

inlinevirtual

{ hostConstants.maxTokenLifeTime = d; }

virtual void inet::IPv6InterfaceData::_setMaxUnicastSolicit ( uint  d )

inlinevirtual

{ nodeConstants.maxUnicastSolicit = d; }

virtual void inet::IPv6InterfaceData::_setMinDelayBetweenRAs ( simtime_t  d )

inlinevirtual

{ routerConstants.minDelayBetweenRAs = d; }

virtual void inet::IPv6InterfaceData::_setMinRandomFactor ( double  d )

inlinevirtual

{ nodeConstants.minRandomFactor = d; }

virtual void inet::IPv6InterfaceData::_setReachableTime ( simtime_t  d )

inlinevirtual

{ nodeConstants.reachableTime = d; }

virtual void inet::IPv6InterfaceData::_setRetransTimer ( simtime_t  d )

inlinevirtual

{ nodeConstants.retransTimer = d; }

virtual void inet::IPv6InterfaceData::_setRtrSolicitationInterval ( simtime_t  d )

inlinevirtual

{ hostConstants.rtrSolicitationInterval = d; }

void inet::IPv6InterfaceData::addAdvPrefix ( const AdvPrefix &  advPrefix )

virtual

Adds the given advertised prefix to the interface.

Referenced by inet::FlatNetworkConfigurator6::configureAdvPrefixes(), and inet::IPv6RoutingTable::configureInterfaceFromXML().

{
    rtrVars.advPrefixList.push_back(advPrefix);
}

void inet::IPv6InterfaceData::addMulticastListener ( const IPv6Address &  multicastAddress )

virtual

{
    if (!multicastAddress.isMulticast())
        throw cRuntimeError("IPv6InterfaceData::addMulticastListener(): multicast address expected, received %s.", multicastAddress.str().c_str());

    if (!hasMulticastListener(multicastAddress)) {
        getRouterData()->reportedMulticastGroups.push_back(multicastAddress);
        changed1(F_MULTICAST_LISTENERS);
    }
}

bool inet::IPv6InterfaceData::addrLess ( const AddressData &  a, const AddressData &  b  )

staticprotected

Referenced by choosePreferredAddress().

{
    // This method is used in choosePreferredAddress().
    // sort() produces increasing order, so "better" addresses should
    // compare as "less", to make them appear first in the array
    if (a.tentative != b.tentative)
        return !a.tentative; // tentative=false is better
    if (a.address.getScope() != b.address.getScope())
        return a.address.getScope() > b.address.getScope(); // bigger scope is better

#ifdef WITH_xMIPv6
    // FIXME  check a.address.isGlobal() != b.address.isGlobal()

    if (a.address.isGlobal() && b.address.isGlobal() && a.addrType != b.addrType)
        return a.addrType == CoA; // HoA is better than CoA, 24.9.07 - CB
#endif /* WITH_xMIPv6 */

    return (a.expiryTime == SIMTIME_ZERO && b.expiryTime != SIMTIME_ZERO) || a.expiryTime > b.expiryTime;    // longer expiry time is better
}

void inet::IPv6InterfaceData::assignAddress ( const IPv6Address &  addr, bool  tentative, simtime_t  expiryTime, simtime_t  prefExpiryTime, bool  hFlag = false  )

virtual

Assigns the given address to the interface.

WITH_xMIPv6: Also takes into account the status of the H-Flag in the recieved RA. Called from IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf( IPv6NDPrefixInformation& prefixInfo, InterfaceEntry* ie, bool hFlag). Relevant only when MIPv6 is supported. (Zarrar Yousaf 20.07.07)

Referenced by inet::UDP::addMulticastAddressToInterface(), inet::IPv6NeighbourDiscovery::assignLinkLocalAddress(), inet::IPv6RoutingTable::assignRequiredNodeAddresses(), inet::FlatNetworkConfigurator6::configureAdvPrefixes(), inet::IPv6RoutingTable::configureInterfaceFromXML(), deduceAdvPrefix(), detailedInfo(), inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent(), inet::IPv6NeighbourDiscovery::processRAPrefixInfo(), inet::IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf(), and updateHomeNetworkInfo().

{
    addresses.push_back(AddressData());
    AddressData& a = addresses.back();
    a.address = addr;
    a.tentative = tentative;
    a.expiryTime = expiryTime;
    a.prefExpiryTime = prefExpiryTime;

#ifdef WITH_xMIPv6
    if (addr.isGlobal()) {    //only tag a global scope address as HoA or CoA, depending on the status of the H-Flag
        if (hFlag == true)
            a.addrType = HoA; //if H-Flag is set then the auto-conf address is the Home address -.....
        else
            a.addrType = CoA; // else it is a care of address (CoA)
    }
    // FIXME else a.addrType = ???;
#endif /* WITH_xMIPv6 */

    choosePreferredAddress();
    changed1(F_IP_ADDRESS);
}

const IPv6Address inet::IPv6InterfaceData::autoConfRouterGlobalScopeAddress

(

int

i

)

This function autoconfigures a global scope address for the router only, if and only the prefix is provided via some exernal method, For instance FlatNetworkConfigurator6 assigning prefixes to routers interfaces during initialization.

Referenced by deduceAdvPrefix(), and inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent().

{
    AdvPrefix& p = rtrVars.advPrefixList[i];
    IPv6Address prefix = p.prefix;
    short length = p.prefixLength;
    IPv6Address linkLocalAddr = getLinkLocalAddress();
    IPv6Address globalAddress = linkLocalAddr.setPrefix(prefix, length);    //the global address gets autoconfigured, given its prefix, which during initialisation is supplied by the FlatnetworkConfigurator6
    p.rtrAddress = globalAddress;    //the newly formed global address from the respective adv prefix is stored in the AdvPrefix list, which will be used later by the RA prefix info option
    return globalAddress;
}

void inet::IPv6InterfaceData::autoConfRouterGlobalScopeAddress

(

AdvPrefix &

p

)

{
    IPv6Address prefix = p.prefix;
    short length = p.prefixLength;
    IPv6Address linkLocalAddr = getLinkLocalAddress();
    IPv6Address globalAddress = linkLocalAddr.setPrefix(prefix, length);    //the global address gets autoconfigured, given its prefix, which during initialisation is supplied by the FlatnetworkConfigurator6
    p.rtrAddress = globalAddress;    //the newly formed global address from the respective adv prefix is stored in the AdvPrefix list, which will be used later by the RA prefix info option
}

void inet::IPv6InterfaceData::changed1 ( int  fieldId )

inlineprotected

Referenced by addMulticastListener(), assignAddress(), joinMulticastGroup(), leaveMulticastGroup(), removeAddress(), and removeMulticastListener().

{ changed(NF_INTERFACE_IPv6CONFIG_CHANGED, fieldId); }

void inet::IPv6InterfaceData::choosePreferredAddress ( )

protected

Referenced by assignAddress(), permanentlyAssign(), removeAddress(), tentativelyAssign(), and updateMatchingAddressExpiryTimes().

{
    // do we have addresses?
    if (addresses.size() == 0) {
        preferredAddr = IPv6Address();
        return;
    }

    // FIXME shouldn't we stick to the current preferredAddress if its prefLifetime
    // hasn't expired yet?

    // FIXME TBD throw out expired addresses! 0 should be treated as infinity

    // sort addresses by scope and expiry time, then pick the first one
    std::stable_sort(addresses.begin(), addresses.end(), addrLess);
    // choose first unicast address
    for (auto & elem : addresses) {
        if (elem.address.isUnicast()) {
            preferredAddr = elem.address;
            preferredAddrExpiryTime = elem.expiryTime;
            return;
        }
    }
    preferredAddr = IPv6Address::UNSPECIFIED_ADDRESS;
}

void inet::IPv6InterfaceData::deduceAdvPrefix

(

)

{
    for (int i = 0; i < getNumAdvPrefixes(); i++) {
        IPv6InterfaceData::AdvPrefix& p = rtrVars.advPrefixList[i];
        /*IPv6Address globalAddr = */
        autoConfRouterGlobalScopeAddress(p);
        assignAddress(p.rtrAddress, false, SIMTIME_ZERO, SIMTIME_ZERO);
    }
}

std::string inet::IPv6InterfaceData::detailedInfo ( ) const

override

{
    return info();    // TBD this could be improved: multi-line text, etc
}

int inet::IPv6InterfaceData::findAddress ( const IPv6Address &  addr ) const

protected

Referenced by getAddressType(), hasAddress(), isTentativeAddress(), permanentlyAssign(), and removeAddress().

{
    for (AddressDataVector::const_iterator it = addresses.begin(); it != addresses.end(); it++)
        if (it->address == addr)
            return it - addresses.begin();

    return -1;
}

simtime_t inet::IPv6InterfaceData::generateReachableTime ( double  MIN_RANDOM_FACTOR, double  MAX_RANDOM_FACTOR, uint  baseReachableTime  )

virtual

This method randomly generates a reachableTime given the MIN_RANDOM_FACTOR MAX_RANDOM_FACTOR and baseReachableTime.

Refer to RFC 2461: Section 6.3.2

Referenced by inet::IPv6NeighbourDiscovery::processRAForRouterUpdates().

{
    return RNGCONTEXT uniform(MIN_RANDOM_FACTOR, MAX_RANDOM_FACTOR) * baseReachableTime;
}

simtime_t inet::IPv6InterfaceData::generateReachableTime ( )

virtual

Arg-less version.

Referenced by IPv6InterfaceData().

{
    return RNGCONTEXT uniform(_getMinRandomFactor(), _getMaxRandomFactor()) * getBaseReachableTime();
}

const IPv6Address & inet::IPv6InterfaceData::getAddress

(

int

i

)

const

Returns ith address of the interface.

Referenced by inet::PingApp::getAllAddresses(), info(), inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent(), inet::sctp::SCTPAssociation::processInitArrived(), inet::IPv6NeighbourDiscovery::processRAPrefixInfo(), inet::IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf(), and inet::sctp::SCTPAssociation::sendInit().

{
    ASSERT(i >= 0 && i < (int)addresses.size());
    return addresses[i].address;
}

IPv6InterfaceData::AddressType inet::IPv6InterfaceData::getAddressType

(

int

i

)

const

Returns the address type (HoA, CoA) of the ith address of the interface.

4.9.07 - CB

Referenced by getAddressType(), and inet::IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf().

{
    ASSERT(i >= 0 && i < (int)addresses.size());
    return addresses[i].addrType;
}

IPv6InterfaceData::AddressType inet::IPv6InterfaceData::getAddressType

(

const IPv6Address &

addr

)

const

Returns the address type (HoA, CoA) of the provided address of the interface.

27.9.07 - CB

{
    return getAddressType(findAddress(addr));
}

short inet::IPv6InterfaceData::getAdvCurHopLimit ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createAndSendRAPacket().

{ return rtrVars.advCurHopLimit; }

simtime_t inet::IPv6InterfaceData::getAdvDefaultLifetime ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createAndSendRAPacket().

{ return rtrVars.advDefaultLifetime; }

bool inet::IPv6InterfaceData::getAdvHomeAgentFlag ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createAndSendRAPacket().

{ return rtrVars.advHomeAgentFlag; }

int inet::IPv6InterfaceData::getAdvLinkMTU ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createAndSendRAPacket().

{ return rtrVars.advLinkMTU; }

bool inet::IPv6InterfaceData::getAdvManagedFlag ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createAndSendRAPacket().

{ return rtrVars.advManagedFlag; }

bool inet::IPv6InterfaceData::getAdvOtherConfigFlag ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createAndSendRAPacket().

{ return rtrVars.advOtherConfigFlag; }

const IPv6InterfaceData::AdvPrefix & inet::IPv6InterfaceData::getAdvPrefix

(

int

i

)

const

Returns the ith advertised prefix on the interface.

Referenced by inet::FlatNetworkConfigurator6::addOwnAdvPrefixRoutes(), inet::FlatNetworkConfigurator6::addStaticRoutes(), inet::IPv6NeighbourDiscovery::createAndSendRAPacket(), info(), inet::IPv6RoutingTable::initialize(), inet::InterfaceTable::isNeighborAddress(), and inet::IPv6RoutingTable::isOnLinkAddress().

{
    ASSERT(i >= 0 && i < (int)rtrVars.advPrefixList.size());
    return rtrVars.advPrefixList[i];
}

int inet::IPv6InterfaceData::getAdvReachableTime ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createAndSendRAPacket().

{ return rtrVars.advReachableTime; }

int inet::IPv6InterfaceData::getAdvRetransTimer ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createAndSendRAPacket().

{ return rtrVars.advRetransTimer; }

bool inet::IPv6InterfaceData::getAdvSendAdvertisements ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createAndSendRAPacket(), inet::IPv6NeighbourDiscovery::createAndSendRSPacket(), inet::IPv6NeighbourDiscovery::initialize(), inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent(), inet::IPv6NeighbourDiscovery::processRAPacket(), and inet::IPv6NeighbourDiscovery::processRSPacket().

{ return rtrVars.advSendAdvertisements; }

uint inet::IPv6InterfaceData::getBaseReachableTime ( ) const

inline

Referenced by generateReachableTime(), and IPv6InterfaceData().

{ return hostVars.baseReachableTime; }

short inet::IPv6InterfaceData::getCurHopLimit ( ) const

inline

{ return hostVars.curHopLimit; }

int inet::IPv6InterfaceData::getDupAddrDetectTransmits ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::assignLinkLocalAddress(), and inet::IPv6NeighbourDiscovery::processDADTimeout().

{ return nodeVars.dupAddrDetectTransmits; }

const IPv6Address & inet::IPv6InterfaceData::getGlobalAddress

(

AddressType

type = HoA

)

const

Returns the first valid global address of the interface, or UNSPECIFIED_ADDRESS if there's none.

Referenced by inet::xMIPv6::createAndSendBRRMessage(), inet::xMIPv6::createAndSendBUMessage(), inet::IPv6NeighbourDiscovery::processRAPacket(), inet::IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf(), inet::IPv6::resolveMACAddressAndSendPacket(), inet::xMIPv6::sendTestInit(), inet::xMIPv6::triggerRouteOptimization(), updateHomeNetworkInfo(), and inet::xMIPv6::validateCoTMessage().

{
    for (const auto & elem : addresses)
        if (elem.address.isGlobal() && elem.addrType == type) // FIXME and valid, 25.9.07 - CB
            return elem.address;

    return IPv6Address::UNSPECIFIED_ADDRESS;
}

const IPv6Address& inet::IPv6InterfaceData::getHomeAgentAddress ( ) const

inline

Referenced by inet::xMIPv6::cancelEntries(), inet::xMIPv6::createAndSendBUMessage(), inet::xMIPv6::createBUTimer(), inet::xMIPv6::createDeregisterBUTimer(), inet::IPv6Tunneling::decapsulateDatagram(), inet::xMIPv6::handleBULExpiry(), inet::xMIPv6::initiateMIPv6Protocol(), inet::xMIPv6::processBAMessage(), inet::xMIPv6::returningHome(), and inet::xMIPv6::validateBAck().

{ return homeInfo.homeAgentAddr; }    // Zarrar 03.09.07

HostMulticastData* inet::IPv6InterfaceData::getHostData ( )

inlineprotected

Referenced by joinMulticastGroup(), and leaveMulticastGroup().

{ if (!hostMcastData) hostMcastData = new HostMulticastData(); return hostMcastData; }

const HostMulticastData* inet::IPv6InterfaceData::getHostData ( ) const

inlineprotected

Referenced by getHostData().

{ return const_cast<IPv6InterfaceData *>(this)->getHostData(); }

const IPv6AddressVector& inet::IPv6InterfaceData::getJoinedMulticastGroups ( ) const

inline

Referenced by isMemberOfMulticastGroup().

{ return getHostData()->joinedMulticastGroups; }

const IPv6Address & inet::IPv6InterfaceData::getLinkLocalAddress

(

)

const

Returns the first valid link-local address of the interface, or UNSPECIFIED_ADDRESS if there's none.

Referenced by inet::FlatNetworkConfigurator6::addStaticRoutes(), inet::IPv6NeighbourDiscovery::assignLinkLocalAddress(), autoConfRouterGlobalScopeAddress(), inet::FlatNetworkConfigurator6::configureAdvPrefixes(), inet::IPv6NeighbourDiscovery::createAndSendRAPacket(), inet::IPv6NeighbourDiscovery::createAndSendRSPacket(), inet::IPv6AddressType::getLinkLocalAddress(), inet::IPv6NeighbourDiscovery::processRAPrefixInfo(), and inet::IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf().

{
    for (const auto & elem : addresses)
        if (elem.address.isLinkLocal()) // FIXME and valid
            return elem.address;

    return IPv6Address::UNSPECIFIED_ADDRESS;
}

uint inet::IPv6InterfaceData::getLinkMTU ( ) const

inline

{ return hostVars.linkMTU; }

simtime_t inet::IPv6InterfaceData::getMaxRtrAdvInterval ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createRATimer(), and inet::IPv6NeighbourDiscovery::sendPeriodicRA().

{ return rtrVars.maxRtrAdvInterval; }

simtime_t inet::IPv6InterfaceData::getMinRtrAdvInterval ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::createRATimer(), and inet::IPv6NeighbourDiscovery::sendPeriodicRA().

{ return rtrVars.minRtrAdvInterval; }

const IPv6Address& inet::IPv6InterfaceData::getMNHomeAddress ( ) const

inline

Referenced by inet::IPv6Tunneling::decapsulateDatagram(), inet::IPv6RoutingTable::getHomeAddress(), inet::xMIPv6::handleTokenExpiry(), inet::xMIPv6::initiateMIPv6Protocol(), inet::IPv6RoutingTable::isHomeAddress(), inet::xMIPv6::processBAMessage(), inet::IPv6::resolveMACAddressAndSendPacket(), and inet::xMIPv6::returningHome().

{ return homeInfo.HoA; }    // Zarrar 03.09.07

const IPv6Address& inet::IPv6InterfaceData::getMNPrefix ( ) const

inline

{ return homeInfo.prefix    /*.prefix()*/; }    // Zarrar 03.09.07

int inet::IPv6InterfaceData::getNumAddresses ( ) const

inline

Returns the number of addresses the interface has.

Referenced by inet::PingApp::getAllAddresses(), info(), inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent(), inet::IPv6NeighbourDiscovery::processRAPrefixInfo(), inet::IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf(), inet::sctp::SCTPAssociation::sendInit(), and inet::InterfaceTable::updateLinkDisplayString().

{ return addresses.size(); }

int inet::IPv6InterfaceData::getNumAdvPrefixes ( ) const

inline

Returns the number of advertised prefixes on the interface.

Referenced by inet::FlatNetworkConfigurator6::addOwnAdvPrefixRoutes(), inet::FlatNetworkConfigurator6::addStaticRoutes(), inet::FlatNetworkConfigurator6::configureAdvPrefixes(), inet::IPv6NeighbourDiscovery::createAndSendRAPacket(), deduceAdvPrefix(), info(), inet::IPv6RoutingTable::initialize(), inet::InterfaceTable::isNeighborAddress(), inet::IPv6RoutingTable::isOnLinkAddress(), and inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent().

{ return rtrVars.advPrefixList.size(); }

const IPv6Address& inet::IPv6InterfaceData::getPreferredAddress ( ) const

inline

Chooses a preferred address for the interface and returns it.

This is the address that should be used as source address for outgoing datagrams, if one is not explicitly specified.

Selection is based on scope (globally routable addresses are preferred), then on lifetime (the one that expires last is chosen). See private choosePreferredAddress() function.

FIXME turn into preferredGLOBALAddress()!

Referenced by inet::xMIPv6::createAndSendBUMessage(), inet::IPv6NeighbourDiscovery::createAndSendRSPacket(), inet::IPv6::fragmentAndSend(), inet::L3AddressResolver::getInterfaceIPv6Address(), inet::L3AddressResolver::getIPv6AddressFrom(), inet::GPSR::getSelfAddress(), inet::IPv6NeighbourDiscovery::initiateAddressResolution(), inet::IPv6NeighbourDiscovery::sendSolicitedNA(), inet::IPv6NeighbourDiscovery::sendUnsolicitedNA(), and inet::InterfaceTable::updateLinkDisplayString().

{ return preferredAddr; }    // FIXME TBD check expiry time!

simtime_t inet::IPv6InterfaceData::getReachableTime ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::processRAForRouterUpdates().

{ return hostVars.reachableTime; }

const IPv6AddressVector& inet::IPv6InterfaceData::getReportedMulticastGroups ( ) const

inline

{ return getRouterData()->reportedMulticastGroups; }

uint inet::IPv6InterfaceData::getRetransTimer ( ) const

inline

Referenced by inet::IPv6NeighbourDiscovery::initiateDAD(), and inet::IPv6NeighbourDiscovery::processDADTimeout().

{ return hostVars.retransTimer; }

RouterMulticastData* inet::IPv6InterfaceData::getRouterData ( )

inlineprotected

Referenced by addMulticastListener(), hasMulticastListener(), and removeMulticastListener().

{ if (!routerMcastData) routerMcastData = new RouterMulticastData(); return routerMcastData; }

const RouterMulticastData* inet::IPv6InterfaceData::getRouterData ( ) const

inlineprotected

Referenced by getRouterData().

{ return const_cast<IPv6InterfaceData *>(this)->getRouterData(); }

bool inet::IPv6InterfaceData::hasAddress

(

const IPv6Address &

addr

)

const

Returns true if the given address is one of the addresses assigned, regardless whether it is tentative or not.

Referenced by inet::L3AddressResolver::findHostWithAddress(), inet::InterfaceTable::findInterfaceByAddress(), inet::IPv6RoutingTable::getInterfaceByAddress(), inet::IPv6NeighbourDiscovery::initiateAddressResolution(), inet::IPv6RoutingTable::isLocalAddress(), and inet::IPv6NeighbourDiscovery::processNSPacket().

{
    return findAddress(addr) != -1;
}

bool inet::IPv6InterfaceData::hasMulticastListener

(

const IPv6Address &

multicastAddress

)

const

Referenced by addMulticastListener().

{
    const IPv6AddressVector& multicastGroups = getRouterData()->reportedMulticastGroups;
    return find(multicastGroups.begin(), multicastGroups.end(), multicastAddress) != multicastGroups.end();
}

std::string inet::IPv6InterfaceData::info ( ) const

override

{
    // FIXME FIXME FIXME FIXME info() should never print a newline
    std::ostringstream os;
    os << "IPv6:{" << endl;
    for (int i = 0; i < getNumAddresses(); i++) {
        os << (i ? "\t            , " : "\tAddrs:") << getAddress(i)
           << "(" << IPv6Address::scopeName(getAddress(i).getScope())
           << (isTentativeAddress(i) ? " tent" : "") << ") "

            #ifdef WITH_xMIPv6
// TODO: revise, routing table is not that simple to access
//           << ((rt6->isMobileNode() && getAddress(i).isGlobal())
//               ? (addresses[i].addrType==HoA ? "HoA" : "CoA") : "")
            #endif /* WITH_xMIPv6 */

           << " expiryTime: " << (addresses[i].expiryTime == SIMTIME_ZERO ? "inf" : SIMTIME_STR(addresses[i].expiryTime))
           << " prefExpiryTime: " << (addresses[i].prefExpiryTime == SIMTIME_ZERO ? "inf" : SIMTIME_STR(addresses[i].prefExpiryTime))
           << endl;
    }

    if (hostMcastData)
        os << hostMcastData->info();

    for (int i = 0; i < getNumAdvPrefixes(); i++) {
        const AdvPrefix& a = getAdvPrefix(i);
        os << (i ? ", " : "\tAdvPrefixes: ") << a.prefix << "/" << a.prefixLength << "("
           << (a.advOnLinkFlag ? "" : "off-link ")
           << (a.advAutonomousFlag ? "" : "non-auto ");

#ifdef WITH_xMIPv6
        os << "R-Flag = " << (a.advRtrAddr ? "1 " : "0 ");
#endif /* WITH_xMIPv6 */

        if (a.advValidLifetime == SIMTIME_ZERO)
            os << "lifetime:inf";
        else if (a.advValidLifetime > SIMTIME_ZERO)
            os << "expires:" << a.advValidLifetime;
        else
            os << "lifetime:+" << (-1 * a.advValidLifetime);
        os << ")" << endl;
    }
    os << " ";

    if (routerMcastData)
        os << routerMcastData->info();

    // uncomment the following as needed!
    os << "\tNode:";
    os << " dupAddrDetectTrans=" << nodeVars.dupAddrDetectTransmits;
    //os << " curHopLimit=" << hostVars.curHopLimit;
    //os << " retransTimer=" << hostVars.retransTimer;
    //os << " baseReachableTime=" << hostVars.baseReachableTime;
    os << " reachableTime=" << hostVars.reachableTime << endl;

#ifdef WITH_xMIPv6
    // the following is for MIPv6 support
    // 4.9.07 - Zarrar, CB
// TODO: revise, routing table is not that simple to access
//    if ( rt6->isMobileNode() )
//        os << "\tHome Network Info: " << " HoA="<< homeInfo.HoA << ", HA=" << homeInfo.homeAgentAddr
//           << ", home prefix=" << homeInfo.prefix/*.prefix()*/ << "\n";
#endif /* WITH_xMIPv6 */

    if (rtrVars.advSendAdvertisements) {
        os << "\tRouter:";
        os << " maxRtrAdvInt=" << rtrVars.maxRtrAdvInterval;
        os << " minRtrAdvInt=" << rtrVars.minRtrAdvInterval << endl;
        //os << " advManagedFlag=" << rtrVars.advManagedFlag;
        //os << " advOtherFlag=" << rtrVars.advOtherFlag;
        //os << " advLinkMTU=" << rtrVars.advLinkMTU;
        //os << " advReachableTime=" << rtrVars.advReachableTime;
        //os << " advRetransTimer=" << rtrVars.advRetransTimer;
        //os << " advCurHopLimit=" << rtrVars.advCurHopLimit;
        //os << " advDefaultLifetime=" << rtrVars.advDefaultLifetime;
    }

    os << "   }" << endl;
    return os.str();
}

bool inet::IPv6InterfaceData::isDADInProgress ( )

inline

Referenced by inet::IPv6NeighbourDiscovery::processRAPacket().

{ return dadInProgress; };

bool inet::IPv6InterfaceData::isMemberOfMulticastGroup

(

const IPv6Address &

multicastAddress

)

const

{
    const IPv6AddressVector& multicastGroups = getJoinedMulticastGroups();
    return find(multicastGroups.begin(), multicastGroups.end(), multicastAddress) != multicastGroups.end();
}

bool inet::IPv6InterfaceData::isTentativeAddress

(

int

i

)

const

Returns true if the ith address of the interface is tentative.

Referenced by inet::IPv6NeighbourDiscovery::assignLinkLocalAddress(), inet::IPv6NeighbourDiscovery::createAndSendRSPacket(), inet::IPv6::endService(), inet::IPv6::fragmentAndSend(), info(), inet::IPv6NeighbourDiscovery::processNAPacket(), inet::IPv6NeighbourDiscovery::processNSPacket(), and inet::IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf().

{
    ASSERT(i >= 0 && i < (int)addresses.size());
    return addresses[i].tentative;
}

bool inet::IPv6InterfaceData::isTentativeAddress

(

const IPv6Address &

addr

)

const

Returns true if the interface has the given address and it is tentative.

{
    int k = findAddress(addr);
    return k != -1 && addresses[k].tentative;
}

void inet::IPv6InterfaceData::joinMulticastGroup ( const IPv6Address &  multicastAddress )

virtual

Referenced by inet::IPv6RoutingTable::configureInterfaceForIPv6().

{
    if (!multicastAddress.isMulticast())
        throw cRuntimeError("IPv6InterfaceData::joinMulticastGroup(): multicast address expected, received %s.", multicastAddress.str().c_str());

    IPv6AddressVector& multicastGroups = getHostData()->joinedMulticastGroups;

    std::vector<int>& refCounts = getHostData()->refCounts;
    for (int i = 0; i < (int)multicastGroups.size(); ++i) {
        if (multicastGroups[i] == multicastAddress) {
            refCounts[i]++;
            return;
        }
    }

    multicastGroups.push_back(multicastAddress);
    refCounts.push_back(1);

    changed1(F_MULTICAST_ADDRESSES);

    cModule *m = ownerp ? dynamic_cast<cModule *>(ownerp->getInterfaceTable()) : nullptr;
    if (m) {
        IPv6MulticastGroupInfo info(ownerp, multicastAddress);
        m->emit(NF_IPv6_MCAST_JOIN, &info);
    }
}

void inet::IPv6InterfaceData::leaveMulticastGroup ( const IPv6Address &  multicastAddress )

virtual

{
    if (!multicastAddress.isMulticast())
        throw cRuntimeError("IPv6InterfaceData::leaveMulticastGroup(): multicast address expected, received %s.", multicastAddress.str().c_str());

    IPv6AddressVector& multicastGroups = getHostData()->joinedMulticastGroups;
    std::vector<int>& refCounts = getHostData()->refCounts;
    for (int i = 0; i < (int)multicastGroups.size(); ++i) {
        if (multicastGroups[i] == multicastAddress) {
            if (--refCounts[i] == 0) {
                multicastGroups.erase(multicastGroups.begin() + i);
                refCounts.erase(refCounts.begin() + i);

                changed1(F_MULTICAST_ADDRESSES);

                cModule *m = ownerp ? dynamic_cast<cModule *>(ownerp->getInterfaceTable()) : nullptr;
                if (m) {
                    IPv6MulticastGroupInfo info(ownerp, multicastAddress);
                    m->emit(NF_IPv6_MCAST_LEAVE, &info);
                }
            }
        }
    }
}

bool inet::IPv6InterfaceData::matchesSolicitedNodeMulticastAddress

(

const IPv6Address &

solNodeAddr

)

const

Returns true if the interface has an address matching the given solicited-node multicast addresses.

Referenced by inet::IPv6RoutingTable::isLocalAddress().

{
    for (const auto & elem : addresses)
        if (elem.address.formSolicitedNodeMulticastAddress() == solNodeAddr)
            return true;

    return false;
}

void inet::IPv6InterfaceData::permanentlyAssign ( const IPv6Address &  addr )

virtual

Clears the "tentative" flag of an existing interface address.

Referenced by inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent().

{
    int k = findAddress(addr);
    ASSERT(k != -1);
    addresses[k].tentative = false;
    choosePreferredAddress();
}

void inet::IPv6InterfaceData::removeAddress ( const IPv6Address &  address )

virtual

Removes the address.

Called when the valid lifetime expires.

Referenced by inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent(), and inet::IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf().

{
    int k = findAddress(address);
    ASSERT(k != -1);
    addresses.erase(addresses.begin() + k);
    choosePreferredAddress();
    changed1(F_IP_ADDRESS);
}

IPv6Address inet::IPv6InterfaceData::removeAddress

(

IPv6InterfaceData::AddressType

type

)

Removes a CoA address from the interface if one exists.

This method traverses the address list and searches for a specific address.

The element is removed and returned.

{
    IPv6Address addr;

    for (auto it = addresses.begin(); it != addresses.end(); ++it) {    // 24.9.07 - CB
        if ((*it).addrType == type) {
            addr = it->address;
            addresses.erase(it);
            break;    // it is assumed that we do not have more than one CoA
        }
    }

    // pick new address as we've removed the old one
    choosePreferredAddress();
    changed1(F_IP_ADDRESS);

    return addr;
}

void inet::IPv6InterfaceData::removeAdvPrefix ( int  i )

virtual

Remove the ith advertised prefix on the interface.

Prefixes at larger indices will shift down.

{
    ASSERT(i >= 0 && i < (int)rtrVars.advPrefixList.size());
    rtrVars.advPrefixList.erase(rtrVars.advPrefixList.begin() + i);
}

void inet::IPv6InterfaceData::removeMulticastListener ( const IPv6Address &  multicastAddress )

virtual

{
    IPv6AddressVector& multicastGroups = getRouterData()->reportedMulticastGroups;

    int n = multicastGroups.size();
    int i;
    for (i = 0; i < n; i++)
        if (multicastGroups[i] == multicastAddress)
            break;

    if (i != n) {
        multicastGroups.erase(multicastGroups.begin() + i);
        changed1(F_MULTICAST_LISTENERS);
    }
}

virtual void inet::IPv6InterfaceData::setAdvCurHopLimit ( short  d )

inlinevirtual

{ rtrVars.advCurHopLimit = d; }

virtual void inet::IPv6InterfaceData::setAdvDefaultLifetime ( simtime_t  d )

inlinevirtual

{ rtrVars.advDefaultLifetime = d; }

virtual void inet::IPv6InterfaceData::setAdvHomeAgentFlag ( bool  d )

inlinevirtual

{ rtrVars.advHomeAgentFlag = d; }

virtual void inet::IPv6InterfaceData::setAdvLinkMTU ( int  d )

inlinevirtual

{ rtrVars.advLinkMTU = d; }

virtual void inet::IPv6InterfaceData::setAdvManagedFlag ( bool  d )

inlinevirtual

{ rtrVars.advManagedFlag = d; }

virtual void inet::IPv6InterfaceData::setAdvOtherConfigFlag ( bool  d )

inlinevirtual

{ rtrVars.advOtherConfigFlag = d; }

void inet::IPv6InterfaceData::setAdvPrefix ( int  i, const AdvPrefix &  advPrefix  )

virtual

Changes the configuration of the ith advertised prefix on the interface.

The prefix itself should stay the same.

{
    ASSERT(i >= 0 && i < (int)rtrVars.advPrefixList.size());
    ASSERT(rtrVars.advPrefixList[i].prefix == advPrefix.prefix);
    ASSERT(rtrVars.advPrefixList[i].prefixLength == advPrefix.prefixLength);
    rtrVars.advPrefixList[i] = advPrefix;
}

virtual void inet::IPv6InterfaceData::setAdvReachableTime ( int  d )

inlinevirtual

{ rtrVars.advReachableTime = d; }

virtual void inet::IPv6InterfaceData::setAdvRetransTimer ( int  d )

inlinevirtual

{ rtrVars.advRetransTimer = d; }

virtual void inet::IPv6InterfaceData::setAdvSendAdvertisements ( bool  d )

inlinevirtual

Referenced by inet::IPv6RoutingTable::configureInterfaceForIPv6(), and inet::IPv6RoutingTable::configureInterfaceFromXML().

{ rtrVars.advSendAdvertisements = d; }

virtual void inet::IPv6InterfaceData::setBaseReachableTime ( uint  d )

inlinevirtual

Referenced by inet::IPv6NeighbourDiscovery::processRAForRouterUpdates().

{ hostVars.baseReachableTime = d; }

virtual void inet::IPv6InterfaceData::setCurHopLimit ( short  d )

inlinevirtual

Referenced by inet::IPv6NeighbourDiscovery::processRAForRouterUpdates().

{ hostVars.curHopLimit = d; }

void inet::IPv6InterfaceData::setDADInProgress ( bool  val )

inline

Referenced by inet::IPv6NeighbourDiscovery::initiateDAD(), and inet::IPv6NeighbourDiscovery::makeTentativeAddressPermanent().

{ dadInProgress = val; };

virtual void inet::IPv6InterfaceData::setDupAddrDetectTransmits ( int  d )

inlinevirtual

{ nodeVars.dupAddrDetectTransmits = d; }

virtual void inet::IPv6InterfaceData::setLinkMTU ( uint  d )

inlinevirtual

{ hostVars.linkMTU = d; }

virtual void inet::IPv6InterfaceData::setMaxRtrAdvInterval ( simtime_t  d )

inlinevirtual

Referenced by inet::IPv6NeighbourDiscovery::createRATimer().

{ rtrVars.maxRtrAdvInterval = d; }

virtual void inet::IPv6InterfaceData::setMinRtrAdvInterval ( simtime_t  d )

inlinevirtual

Referenced by inet::IPv6NeighbourDiscovery::createRATimer().

{ rtrVars.minRtrAdvInterval = d; }

virtual void inet::IPv6InterfaceData::setReachableTime ( simtime_t  d )

inlinevirtual

Referenced by inet::IPv6NeighbourDiscovery::processRAForRouterUpdates().

{ hostVars.reachableTime = d; }

virtual void inet::IPv6InterfaceData::setRetransTimer ( uint  d )

inlinevirtual

Referenced by inet::IPv6NeighbourDiscovery::processRAForRouterUpdates().

{ hostVars.retransTimer = d; }

void inet::IPv6InterfaceData::tentativelyAssign

(

int

i

)

Sets the "tentative" flag of of the ith address of the interface.

28.09.07 - CB

Referenced by inet::IPv6NeighbourDiscovery::processRAPrefixInfoForAddrAutoConf().

{
    ASSERT(i >= 0 && i < (int)addresses.size());
    addresses[i].tentative = true;
    choosePreferredAddress();
}

void inet::IPv6InterfaceData::updateHomeNetworkInfo	(	const IPv6Address &	hoa,
		const IPv6Address &	ha,
		const IPv6Address &	prefix,
		const int	prefixLength
	)

03.09.07 This updates the struct HomeNetwork Info with the MN's Home Address(HoA), the global scope address of the MNs Home Agent (HA) and the home network prefix.

Referenced by inet::IPv6NeighbourDiscovery::processRAPacket().

{
    EV_INFO << "\n++++++ Updating the Home Network Information \n";
    homeInfo.HoA = hoa;
    homeInfo.homeAgentAddr = ha;
    homeInfo.prefix = prefix;

    // check if we already have a HoA on this interface
    // if not, then we create one
    IPv6Address addr = getGlobalAddress(HoA);

    if (addr == IPv6Address::UNSPECIFIED_ADDRESS)
        this->assignAddress(hoa, false, SIMTIME_ZERO, SIMTIME_ZERO, true);
}

void inet::IPv6InterfaceData::updateMatchingAddressExpiryTimes ( const IPv6Address &  prefix, int  length, simtime_t  expiryTime = SIMTIME_ZERO, simtime_t  prefExpiryTime = SIMTIME_ZERO  )

virtual

Update expiry times of addresses.

Expiry times possibly come from prefixes (with on-link flag set to either zero or one) in Router Advertisements. Zero expiry time means infinity.

{
    for (auto & elem : addresses) {
        if (elem.address.matches(prefix, length)) {
            elem.expiryTime = expiryTime;
            elem.prefExpiryTime = prefExpiryTime;
        }
    }
    choosePreferredAddress();
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const HomeNetworkInfo &  homeNetInfo  )

friend

{
    os << "HoA of MN:" << homeNetInfo.HoA << " HA Address: " << homeNetInfo.homeAgentAddr
       << " Home Network Prefix: " << homeNetInfo.prefix    /*.prefix()*/;
    return os;
}

Member Data Documentation

AddressDataVector inet::IPv6InterfaceData::addresses

protected

Referenced by assignAddress(), choosePreferredAddress(), findAddress(), getAddress(), getAddressType(), getGlobalAddress(), getLinkLocalAddress(), info(), isTentativeAddress(), matchesSolicitedNodeMulticastAddress(), permanentlyAssign(), removeAddress(), tentativelyAssign(), and updateMatchingAddressExpiryTimes().

bool inet::IPv6InterfaceData::dadInProgress = false

protected

HomeNetworkInfo inet::IPv6InterfaceData::homeInfo

protected

Referenced by updateHomeNetworkInfo().

HostConstants inet::IPv6InterfaceData::hostConstants

Referenced by IPv6InterfaceData().

HostMulticastData* inet::IPv6InterfaceData::hostMcastData = nullptr

protected

Referenced by info(), and ~IPv6InterfaceData().

HostVariables inet::IPv6InterfaceData::hostVars

protected

Referenced by info(), and IPv6InterfaceData().

NodeConstants inet::IPv6InterfaceData::nodeConstants

Referenced by IPv6InterfaceData().

NodeVariables inet::IPv6InterfaceData::nodeVars

protected

Referenced by info(), and IPv6InterfaceData().

IPv6Address inet::IPv6InterfaceData::preferredAddr

protected

Referenced by choosePreferredAddress().

simtime_t inet::IPv6InterfaceData::preferredAddrExpiryTime

protected

Referenced by choosePreferredAddress().

RouterConstants inet::IPv6InterfaceData::routerConstants

Referenced by IPv6InterfaceData().

RouterMulticastData* inet::IPv6InterfaceData::routerMcastData = nullptr

protected

Referenced by info(), and ~IPv6InterfaceData().

IPv6RoutingTable* inet::IPv6InterfaceData::rt6 = nullptr

protected

RouterVariables inet::IPv6InterfaceData::rtrVars

protected

Referenced by addAdvPrefix(), autoConfRouterGlobalScopeAddress(), deduceAdvPrefix(), getAdvPrefix(), info(), IPv6InterfaceData(), removeAdvPrefix(), and setAdvPrefix().

---

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

• IPv6InterfaceData.h
• IPv6InterfaceData.cc