org.onosproject.ospf.controller

Interface LsaBin

public interface LsaBin

Representation of a bin where an LSA is stored for aging. A bin is identified by a bin number and can have one or more LSAs stored in a particular bin location.

Method Summary

Modifier and Type	Method and Description
void	addOspfLsa(java.lang.String lsaKey, LsaWrapper lsaWrapper) Adds the given LSA to this bin with the given key.
int	binNumber() Gets the bin number assigned during the initialization process of the bins .
java.util.Map<java.lang.String,LsaWrapper>	listOfLsa() Gets the list of LSAs in this bin as key value pair.
LsaWrapper	ospfLsa(java.lang.String lsaKey) Retrieves the LSA from the bin for verification of max age and ls refresh.
void	removeOspfLsa(java.lang.String lsaKey, LsaWrapper lsaWrapper) Removes the given LSA from the bin.

Method Detail

addOspfLsa

void addOspfLsa(java.lang.String lsaKey,
                LsaWrapper lsaWrapper)

Adds the given LSA to this bin with the given key.

Parameters:

lsaKey - key of the stored LSA

lsaWrapper - wrapper instance to store

ospfLsa

LsaWrapper ospfLsa(java.lang.String lsaKey)

Retrieves the LSA from the bin for verification of max age and ls refresh.

Parameters:

lsaKey - key to search the LSA

Returns:

LSA Wrapper instance

removeOspfLsa

void removeOspfLsa(java.lang.String lsaKey,
                   LsaWrapper lsaWrapper)

Removes the given LSA from the bin. when ever it reaches max age or ls refresh time.

Parameters:

lsaKey - key to search LSA

lsaWrapper - wrapper instance of the particular LSA

listOfLsa

java.util.Map<java.lang.String,LsaWrapper> listOfLsa()

Gets the list of LSAs in this bin as key value pair. with key being the LSA key formed from the LSA header.

Returns:

list of LSAs in this bin as key value pair

binNumber

int binNumber()

Gets the bin number assigned during the initialization process of the bins .

Returns:

the bin number