org.onosproject.ospf.controller

Interface LsdbAge

public interface LsdbAge

Representation of LSDB aging process. The age of each LSA in the database must be incremented by 1 each second. We put all the LSAs of a given age into a single bin. The age of an LSA is the difference between its age bin and the bin representing LS age 0.

Method Summary

Modifier and Type	Method and Description
void	addLsaBin(java.lang.Integer binKey, LsaBin lsaBin) Adds LSA to bin for aging.
void	addLsaToMaxAgeBin(java.lang.String key, LsaWrapper wrapper) Adds the lsa to maxAge bin if LSAs age is max age.
int	age2Bin(int x) Gets the bin number out of LSAs age, in which the LSA can be placed.
void	ageLsaAndFlood() Invoked every 1 second as part of the aging process, and increments age counter.
int	getAgeCounter() Gets the age counter.
int	getAgeCounterRollOver() Gets the age counter roll over.
LsaBin	getLsaBin(java.lang.Integer binKey) Gets LSA from bin, this method is used while processing ls refresh and max age on LSA.
LsaBin	getMaxAgeBin() Gets the max age bin, a special bin is created which holds only max age LSAs.
void	maxAgeLsa() If the LSAs have completed the MaxAge stop aging and flood it.
void	refreshLsa() Refresh the LSAs which are in the refresh bin.
void	removeLsaFromBin(LsaWrapper lsaWrapper) Removes LSA from Bin, when ever it reaches a max age or ls refresh time.
void	startDbAging() Starts the aging timer thread which gets invokes every second.

Method Detail

addLsaBin

void addLsaBin(java.lang.Integer binKey,
               LsaBin lsaBin)

Adds LSA to bin for aging.

Parameters:

binKey - key to store the LSA in bin

lsaBin - LSA bin instance

getLsaBin

LsaBin getLsaBin(java.lang.Integer binKey)

Gets LSA from bin, this method is used while processing ls refresh and max age on LSA.

Parameters:

binKey - key to retrieve the LSA from bin

Returns:

lsaBin bin instance

addLsaToMaxAgeBin

void addLsaToMaxAgeBin(java.lang.String key,
                       LsaWrapper wrapper)

Adds the lsa to maxAge bin if LSAs age is max age.

Parameters:

key - key to store the LSA in bin.

wrapper - wrapper instance which contains LSA

age2Bin

int age2Bin(int x)

Gets the bin number out of LSAs age, in which the LSA can be placed. so that age can be calculated.

Parameters:

x - Can be either age or ageCounter

Returns:

bin number.

getMaxAgeBin

LsaBin getMaxAgeBin()

Gets the max age bin, a special bin is created which holds only max age LSAs.

Returns:

lsa bin instance

getAgeCounter

int getAgeCounter()

Gets the age counter.

Returns:

age counter

refreshLsa

void refreshLsa()

Refresh the LSAs which are in the refresh bin.

maxAgeLsa

void maxAgeLsa()

If the LSAs have completed the MaxAge stop aging and flood it.

ageLsaAndFlood

void ageLsaAndFlood()

Invoked every 1 second as part of the aging process, and increments age counter. It also verifies if any LSA has reached ls refresh time or max age.

startDbAging

void startDbAging()

Starts the aging timer thread which gets invokes every second.

removeLsaFromBin

void removeLsaFromBin(LsaWrapper lsaWrapper)

Removes LSA from Bin, when ever it reaches a max age or ls refresh time.

Parameters:

lsaWrapper - wrapper instance

getAgeCounterRollOver

int getAgeCounterRollOver()

Gets the age counter roll over.

Returns:

the age counter roll over