inet::BindingCache Class Reference

#include <BindingCache.h>

Inheritance diagram for inet::BindingCache:

Classes
struct	BindingCacheEntry

Public Member Functions
	BindingCache ()
virtual	~BindingCache ()
void	addOrUpdateBC (const IPv6Address &hoa, const IPv6Address &coa, const uint lifetime, const uint seq, bool homeReg)
	Sets Binding Cache Entry (BCE) with provided values. More...
uint	readBCSequenceNumber (const IPv6Address &HoA) const
	Returns sequence number of BCE for provided HoA. More...
bool	isInBindingCache (const IPv6Address &HoA, IPv6Address &CoA) const
	Added by CB, 29.08.07 Checks whether there is an entry in the BC for the given HoA and CoA. More...
bool	isInBindingCache (const IPv6Address &HoA) const
	Added by CB, 4.9.07 Checks whether there is an entry in the BC for the given HoA. More...
void	deleteEntry (IPv6Address &HoA)
	Added by CB, 4.9.07 Delete the entry from the cache with the provided HoA. More...
bool	getHomeRegistration (const IPv6Address &HoA) const
	Returns the value of the homeRegistration flag for the given HoA. More...
uint	getLifetime (const IPv6Address &HoA) const
	Returns the lifetime of the binding for the given HoA. More...
virtual int	generateHomeToken (const IPv6Address &HoA, int nonce)
	Generates a home token from the provided parameters. More...
virtual int	generateCareOfToken (const IPv6Address &CoA, int nonce)
	Generates a care-of token from the provided parameters. More...
virtual int	generateKey (int homeToken, int careOfToken, const IPv6Address &CoA)
	Generates the key Kbm from home and care-of keygen token. More...

Protected Member Functions
virtual void	initialize () override
virtual void	handleMessage (cMessage *) override
	Raises an error. More...

Private Types
typedef std::map< IPv6Address, BindingCacheEntry >	BindingCache6

Private Attributes
BindingCache6	bindingCache

Friends
std::ostream &	operator<< (std::ostream &os, const BindingCacheEntry &bce)

Member Typedef Documentation

typedef std::map<IPv6Address, BindingCacheEntry> inet::BindingCache::BindingCache6

private

Constructor & Destructor Documentation

inet::BindingCache::BindingCache

(

)

{
}

inet::BindingCache::~BindingCache ( )

virtual

{
//     for (unsigned int i = 0; i < bindingUpdateList.size(); i++)
//         delete bindingUpdateList[i];
}

Member Function Documentation

void inet::BindingCache::addOrUpdateBC	(	const IPv6Address &	hoa,
		const IPv6Address &	coa,
		const uint	lifetime,
		const uint	seq,
		bool	homeReg
	)

Sets Binding Cache Entry (BCE) with provided values.

If BCE does not yet exist, a new one will be created.

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

{
    EV_INFO << "\n++++++++++++++++++++Binding Cache Being Updated in Routing Table6 ++++++++++++++\n";
    bindingCache[hoa].careOfAddress = coa;
    bindingCache[hoa].bindingLifetime = lifetime;
    bindingCache[hoa].sequenceNumber = seq;
    bindingCache[hoa].isHomeRegisteration = homeReg;
}

void inet::BindingCache::deleteEntry

(

IPv6Address &

HoA

)

Added by CB, 4.9.07 Delete the entry from the cache with the provided HoA.

Referenced by inet::xMIPv6::handleBCExpiry(), and inet::xMIPv6::processBUMessage().

{
    auto pos = bindingCache.find(HoA);

    if (pos != bindingCache.end()) // update 11.9.07 - CB
        bindingCache.erase(pos);
}

int inet::BindingCache::generateCareOfToken ( const IPv6Address &  CoA, int  nonce  )

virtual

Generates a care-of token from the provided parameters.

Returns a static value for now.

Referenced by inet::xMIPv6::processCoTIMessage(), and inet::xMIPv6::validateBUMessage().

{
    return CO_TOKEN;
}

int inet::BindingCache::generateHomeToken ( const IPv6Address &  HoA, int  nonce  )

virtual

Generates a home token from the provided parameters.

Returns a static value for now.

Referenced by inet::xMIPv6::processHoTIMessage(), and inet::xMIPv6::validateBUMessage().

{
    return HO_TOKEN;
}

int inet::BindingCache::generateKey ( int  homeToken, int  careOfToken, const IPv6Address &  CoA  )

virtual

Generates the key Kbm from home and care-of keygen token.

For now, this return the sum of both tokens.

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

{
    // use a dummy value
    return homeToken + careOfToken;
}

bool inet::BindingCache::getHomeRegistration

(

const IPv6Address &

HoA

)

const

Returns the value of the homeRegistration flag for the given HoA.

Referenced by inet::xMIPv6::validateBUderegisterMessage(), and inet::xMIPv6::validateBUMessage().

{
    BindingCache6::const_iterator pos = bindingCache.find(HoA);

    if (pos == bindingCache.end())
        return false; // HoA not yet registered; should not occur anyway
    else
        return pos->second.isHomeRegisteration;
}

uint inet::BindingCache::getLifetime

(

const IPv6Address &

HoA

)

const

Returns the lifetime of the binding for the given HoA.

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

{
    BindingCache6::const_iterator pos = bindingCache.find(HoA);

    if (pos == bindingCache.end())
        return 0; // HoA not yet registered; should not occur anyway
    else
        return pos->second.bindingLifetime;
}

void inet::BindingCache::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

Raises an error.

{
    throw cRuntimeError("This module doesn't process messages");
}

void inet::BindingCache::initialize ( )

overrideprotectedvirtual

{
    WATCH_MAP(bindingCache);    //added by Zarrar Yousaf
}

bool inet::BindingCache::isInBindingCache	(	const IPv6Address &	HoA,
		IPv6Address &	CoA
	)		const

Added by CB, 29.08.07 Checks whether there is an entry in the BC for the given HoA and CoA.

Referenced by inet::xMIPv6::processBUMessage(), inet::xMIPv6::processHoAOpt(), and inet::xMIPv6::validateBUderegisterMessage().

{
    BindingCache6::const_iterator pos = bindingCache.find(HoA);

    if (pos == bindingCache.end())
        return false; // if HoA is not registered then there's obviously no valid entry in the BC

    return pos->second.careOfAddress == CoA;    // if CoA corresponds to HoA, everything is fine
}

bool inet::BindingCache::isInBindingCache

(

const IPv6Address &

HoA

)

const

Added by CB, 4.9.07 Checks whether there is an entry in the BC for the given HoA.

{
    return bindingCache.find(HoA) != bindingCache.end();
}

uint inet::BindingCache::readBCSequenceNumber

(

const IPv6Address &

HoA

)

const

Returns sequence number of BCE for provided HoA.

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

{
    //Reads the sequence number of the last received BU Message
    /*IPv6Address HoA = bu->getHomeAddressMN();
       uint seqNumber = bindingCache[HoA].sequenceNumber;
       return seqNumber;*/

    // update 10.09.07 - CB
    // the code from above creates a new (empty) entry if
    // the provided HoA does not yet exist.
    BindingCache6::const_iterator pos = bindingCache.find(HoA);

    if (pos == bindingCache.end())
        return 0; // HoA not yet registered
    else
        return pos->second.sequenceNumber;
}

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  os, const BindingCacheEntry &  bce  )

friend

{
    os << "CoA of MN:" << bce.careOfAddress << " BU Lifetime: " << bce.bindingLifetime
       << " Home Registeration: " << bce.isHomeRegisteration << " BU_Sequence#: "
       << bce.sequenceNumber << "\n";

    return os;
}

Member Data Documentation

BindingCache6 inet::BindingCache::bindingCache

private

Referenced by addOrUpdateBC(), deleteEntry(), getHomeRegistration(), getLifetime(), initialize(), isInBindingCache(), and readBCSequenceNumber().

---

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

• BindingCache.h
• BindingCache.cc