org.onosproject.ospf.controller.impl

Class OspfNbrImpl

java.lang.Object

org.onosproject.ospf.controller.impl.OspfNbrImpl

All Implemented Interfaces:

org.onosproject.ospf.controller.OspfNbr

public class OspfNbrImpl
extends Object
implements org.onosproject.ospf.controller.OspfNbr

Represents an OSPF neighbor. The first thing an OSPF router must do is find its neighbors and form adjacency. Each neighbor that the router finds will be represented by this class.

Constructor Summary

Constructors

Constructor and Description
OspfNbrImpl(org.onosproject.ospf.controller.OspfArea paramOspfArea, org.onosproject.ospf.controller.OspfInterface paramOspfInterface, org.onlab.packet.Ip4Address ipAddr, org.onlab.packet.Ip4Address routerId, int options, OspfInterfaceChannelHandler handler, org.onosproject.ospf.controller.TopologyForDeviceAndLink topologyForDeviceAndLinkCommon) Creates an instance of Neighbor.

Method Summary

Modifier and Type	Method and Description
void	adjOk(org.jboss.netty.channel.Channel ch) Determines whether an adjacency should be established/maintained with the neighbor or not.
void	badLSReq(org.jboss.netty.channel.Channel ch) Called if a LS Request has been received for an LSA which is not contained in the database.
long	ddSeqNum() Gets the DD sequence number.
void	directAcknowledge(org.onosproject.ospf.protocol.lsa.LsaHeader ackLsa, org.jboss.netty.channel.Channel ch, org.onlab.packet.Ip4Address sourceIp) Sends a direct Acknowledgment for a particular LSA to the Neighbor.
void	exchangeDone(org.onosproject.ospf.protocol.ospfpacket.OspfMessage message, org.jboss.netty.channel.Channel ch) At this point, the router has sent and received an entire sequence of DD packets.
org.onosproject.ospf.protocol.ospfpacket.types.LsRequest	getLastSentLsrPacket() Gets the last sent Ls Request Packet.
Hashtable	getLsReqList() Gets the ls request list.
Map<String,org.onosproject.ospf.controller.OspfLsa>	getPendingReTxList() Gets the pending re transmit list.
Map	getReTxList() Gets the reTxList instance.
org.onosproject.ospf.controller.OspfNeighborState	getState() Gets the neighbors state.
int	isMaster() Gets neighbor is master or not.
String	isNullorLatest(org.onosproject.ospf.controller.LsaWrapper lsWrapper, org.onosproject.ospf.protocol.lsa.LsaHeader recLsa) RFC 2328 Section 13 (5).
boolean	isOpaqueCapable() Gets the neighbor is opaque enabled or not.
org.onosproject.ospf.protocol.ospfpacket.types.DdPacket	lastDdPacket() Gets the last sent DdPacket.
org.onosproject.ospf.protocol.ospfpacket.types.DdPacket	lastSentDdPacket() Gets the last sent DD Packet.
void	loadingDone() Method gets called when no more ls request list and moving to FULL State.
void	negotiationDone(org.onosproject.ospf.protocol.ospfpacket.OspfMessage ospfMessage, boolean neighborIsMaster, List payload, org.jboss.netty.channel.Channel ch) At this point Master/Slave relationship is definitely established.
org.onlab.packet.Ip4Address	neighborBdr() Gets the neighbor BDR address.
void	neighborDown() Called when neighbor is down.
org.onlab.packet.Ip4Address	neighborDr() Gets the neighbor DR address.
org.onlab.packet.Ip4Address	neighborId() Gets neighbor id.
org.onlab.packet.Ip4Address	neighborIpAddr() Gets the IP address of this neighbor.
void	oneWayReceived(org.onosproject.ospf.protocol.ospfpacket.OspfMessage ospfHello, org.jboss.netty.channel.Channel channel) Have seen a Neighbor, but the Neighbor doesn't know about me.
int	options() Gets the options value.
void	processDdPacket(boolean neighborIsMaster, org.onosproject.ospf.protocol.ospfpacket.types.DdPacket dataDescPkt, org.jboss.netty.channel.Channel ch) Called if state is EXCHANGE.
void	processLsas(List ddPayload) Process the LSA Headers received in the last received Database Description OSPFMessage.
void	processLsUpdate(org.onosproject.ospf.protocol.ospfpacket.types.LsUpdate lsUpdPkt, org.jboss.netty.channel.Channel ch) LS Update Packet has been received while state was EXCHANGE or LOADING.
boolean	processReceivedLsa(org.onosproject.ospf.protocol.lsa.LsaHeader recLsa, boolean receivedViaFlooding, org.jboss.netty.channel.Channel ch, org.onlab.packet.Ip4Address sourceIp) Processes the received Lsa.
void	processSelfOriginatedLsa() RFC 2328 section 13.4 Processing self-originated LSAs.
int	routerPriority() Gets router priority.
void	sendLsa(org.onosproject.ospf.protocol.lsa.LsaHeader lsa, org.onlab.packet.Ip4Address destination, org.jboss.netty.channel.Channel ch) Sends the LSA to destination address.
org.onosproject.ospf.protocol.ospfpacket.OspfMessage	seqNumMismatch(String reason) Handles sequence number mis match event.
void	setDdSeqNum(long ddSeqNum) Sets the DD sequence number.
void	setIsMaster(int isMaster) Sets neighbor is master or not.
void	setIsOpaqueCapable(boolean isOpaqueCapable) Sets the neighbor is opaque enabled or not.
void	setLastDdPacket(org.onosproject.ospf.protocol.ospfpacket.types.DdPacket lastDdPacket) Sets the last sent DdPacket.
void	setLastSentDdPacket(org.onosproject.ospf.protocol.ospfpacket.types.DdPacket lastSentDdPacket) Sets the last sent DD Packet.
void	setLastSentLsrPacket(org.onosproject.ospf.protocol.ospfpacket.types.LsRequest lastSentLsrPacket) Sets the last sent Ls Request Packet.
void	setNeighborBdr(org.onlab.packet.Ip4Address neighborBdr) Sets the neighbor BDR address.
void	setNeighborDr(org.onlab.packet.Ip4Address neighborDr) Sets the neighbor DR address.
void	setNeighborId(org.onlab.packet.Ip4Address neighborId) Sets the neighbor id.
void	setOptions(int options) Sets the options value.
void	setRouterPriority(int routerPriority) Sets router priority.
void	setState(org.onosproject.ospf.controller.OspfNeighborState state) Sets the neighbors state.
void	startFloodingTimer(org.jboss.netty.channel.Channel channel) Starts the flooding timer.
void	twoWayReceived(org.onosproject.ospf.protocol.ospfpacket.OspfMessage ospfMessage, org.jboss.netty.channel.Channel channel) Called when a DD OSPFMessage is received while state was INIT.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OspfNbrImpl

public OspfNbrImpl(org.onosproject.ospf.controller.OspfArea paramOspfArea,
                   org.onosproject.ospf.controller.OspfInterface paramOspfInterface,
                   org.onlab.packet.Ip4Address ipAddr,
                   org.onlab.packet.Ip4Address routerId,
                   int options,
                   OspfInterfaceChannelHandler handler,
                   org.onosproject.ospf.controller.TopologyForDeviceAndLink topologyForDeviceAndLinkCommon)

Creates an instance of Neighbor.

Parameters:

paramOspfArea - OSPF Area instance

paramOspfInterface - OSPF interface instance

ipAddr - IP address

routerId - router id

options - options

handler - channel handler instance

topologyForDeviceAndLinkCommon - topology for device and link instance

Method Detail

neighborIpAddr

public org.onlab.packet.Ip4Address neighborIpAddr()

Gets the IP address of this neighbor.

Specified by:

neighborIpAddr in interface org.onosproject.ospf.controller.OspfNbr

Returns:

the IP address of this neighbor

isOpaqueCapable

public boolean isOpaqueCapable()

Gets the neighbor is opaque enabled or not.

Specified by:

isOpaqueCapable in interface org.onosproject.ospf.controller.OspfNbr

Returns:

true if the neighbor is opaque enabled else false.

setIsOpaqueCapable

public void setIsOpaqueCapable(boolean isOpaqueCapable)

Sets the neighbor is opaque enabled or not.

Specified by:

setIsOpaqueCapable in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

isOpaqueCapable - true if the neighbor is opaque enabledelse false

oneWayReceived

public void oneWayReceived(org.onosproject.ospf.protocol.ospfpacket.OspfMessage ospfHello,
                           org.jboss.netty.channel.Channel channel)

Have seen a Neighbor, but the Neighbor doesn't know about me.

Parameters:

ospfHello - Hello Packet instance

channel - netty channel instance

twoWayReceived

public void twoWayReceived(org.onosproject.ospf.protocol.ospfpacket.OspfMessage ospfMessage,
                           org.jboss.netty.channel.Channel channel)
                    throws Exception

Called when a DD OSPFMessage is received while state was INIT.

Parameters:

ospfMessage - ospf message instance

channel - netty channel instance

Throws:

Exception - might throws exception

negotiationDone

public void negotiationDone(org.onosproject.ospf.protocol.ospfpacket.OspfMessage ospfMessage,
                            boolean neighborIsMaster,
                            List payload,
                            org.jboss.netty.channel.Channel ch)
                     throws Exception

At this point Master/Slave relationship is definitely established. DD sequence numbers have been exchanged. This is the begin of sending/receiving of DD OSPFMessages.

Parameters:

ospfMessage - OSPF message instance

neighborIsMaster - neighbor is master or slave

payload - contains the LSAs to add in Dd Packet

ch - netty channel instance

Throws:

Exception - might throws exception

processLsas

public void processLsas(List ddPayload)
                 throws Exception

Process the LSA Headers received in the last received Database Description OSPFMessage.

Parameters:

ddPayload - LSA headers to process

Throws:

Exception - might throws exception

seqNumMismatch

public org.onosproject.ospf.protocol.ospfpacket.OspfMessage seqNumMismatch(String reason)
                                                                    throws Exception

Handles sequence number mis match event.

Parameters:

reason - a string represents the mismatch reason

Returns:

OSPF message instance

Throws:

Exception - might throws exception

badLSReq

public void badLSReq(org.jboss.netty.channel.Channel ch)
              throws Exception

Called if a LS Request has been received for an LSA which is not contained in the database. This indicates an error in the Database Exchange process. Actions to be performed are the same as in seqNumMismatch. In addition, stop the possibly activated re transmission timer.

Specified by:

badLSReq in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

ch - netty channel instance

Throws:

Exception

processDdPacket

public void processDdPacket(boolean neighborIsMaster,
                            org.onosproject.ospf.protocol.ospfpacket.types.DdPacket dataDescPkt,
                            org.jboss.netty.channel.Channel ch)
                     throws Exception

Called if state is EXCHANGE. This method is executed every time a DD Packets arrives. When the last Packet arrives, it transfers the state into LOADING or FULL

Parameters:

neighborIsMaster - true if neighbor is master else false

dataDescPkt - DdPacket instance

ch - netty channel instance

Throws:

Exception - might throws exception

exchangeDone

public void exchangeDone(org.onosproject.ospf.protocol.ospfpacket.OspfMessage message,
                         org.jboss.netty.channel.Channel ch)

At this point, the router has sent and received an entire sequence of DD packets. Now it must be determined whether the new state is FULL, or LS Request packets have to be send.

Parameters:

message - OSPF message instance

ch - netty channel handler

adjOk

public void adjOk(org.jboss.netty.channel.Channel ch)

Determines whether an adjacency should be established/maintained with the neighbor or not.

Specified by:

adjOk in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

ch - netty channel instance

processLsUpdate

public void processLsUpdate(org.onosproject.ospf.protocol.ospfpacket.types.LsUpdate lsUpdPkt,
                            org.jboss.netty.channel.Channel ch)
                     throws Exception

LS Update Packet has been received while state was EXCHANGE or LOADING. Examine the received LSAs, check whether they were requested or not and process them accordingly. Therefore use method "processReceivedLsa" for further treatment.

Parameters:

lsUpdPkt - LS Update Packet received while Neighbor state was EXCHANGE or LOADING

ch - netty channel instance

Throws:

Exception - might throws exception

loadingDone

public void loadingDone()
                 throws Exception

Method gets called when no more ls request list and moving to FULL State.

Throws:

Exception - might throws exception

processReceivedLsa

public boolean processReceivedLsa(org.onosproject.ospf.protocol.lsa.LsaHeader recLsa,
                                  boolean receivedViaFlooding,
                                  org.jboss.netty.channel.Channel ch,
                                  org.onlab.packet.Ip4Address sourceIp)
                           throws Exception

Processes the received Lsa.

Parameters:

recLsa - received Lsa

receivedViaFlooding - received via flooding or not

ch - channel instance

sourceIp - source of this Lsa

Returns:

true to remove it from lsReqList else false

Throws:

Exception - might throws exception

isNullorLatest

public String isNullorLatest(org.onosproject.ospf.controller.LsaWrapper lsWrapper,
                             org.onosproject.ospf.protocol.lsa.LsaHeader recLsa)

RFC 2328 Section 13 (5).

Parameters:

lsWrapper - ls wrapper instance

recLsa - received LSA instance

Returns:

returns a string status

processSelfOriginatedLsa

public void processSelfOriginatedLsa()
                              throws Exception

RFC 2328 section 13.4 Processing self-originated LSAs.

Throws:

Exception - might throws exception

sendLsa

public void sendLsa(org.onosproject.ospf.protocol.lsa.LsaHeader lsa,
                    org.onlab.packet.Ip4Address destination,
                    org.jboss.netty.channel.Channel ch)

Sends the LSA to destination address.

Parameters:

lsa - LSA instance to sent

destination - destination IP address

ch - netty channel instance

directAcknowledge

public void directAcknowledge(org.onosproject.ospf.protocol.lsa.LsaHeader ackLsa,
                              org.jboss.netty.channel.Channel ch,
                              org.onlab.packet.Ip4Address sourceIp)

Sends a direct Acknowledgment for a particular LSA to the Neighbor.

Parameters:

ackLsa - LSA instance

ch - netty channel instance

sourceIp - source IP address

neighborDown

public void neighborDown()
                  throws Exception

Called when neighbor is down.

Throws:

Exception - might throws exception

startFloodingTimer

public void startFloodingTimer(org.jboss.netty.channel.Channel channel)

Starts the flooding timer.

Parameters:

channel - channel instance

lastDdPacket

public org.onosproject.ospf.protocol.ospfpacket.types.DdPacket lastDdPacket()

Gets the last sent DdPacket.

Returns:

DdPacket instance

setLastDdPacket

public void setLastDdPacket(org.onosproject.ospf.protocol.ospfpacket.types.DdPacket lastDdPacket)

Sets the last sent DdPacket.

Parameters:

lastDdPacket - DdPacket instance

neighborId

public org.onlab.packet.Ip4Address neighborId()

Gets neighbor id.

Specified by:

neighborId in interface org.onosproject.ospf.controller.OspfNbr

Returns:

neighbor id

setNeighborId

public void setNeighborId(org.onlab.packet.Ip4Address neighborId)

Sets the neighbor id.

Specified by:

setNeighborId in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

neighborId - neighbor id

neighborDr

public org.onlab.packet.Ip4Address neighborDr()

Gets the neighbor DR address.

Specified by:

neighborDr in interface org.onosproject.ospf.controller.OspfNbr

Returns:

neighbor DR address

setNeighborDr

public void setNeighborDr(org.onlab.packet.Ip4Address neighborDr)

Sets the neighbor DR address.

Specified by:

setNeighborDr in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

neighborDr - neighbor DR address

neighborBdr

public org.onlab.packet.Ip4Address neighborBdr()

Gets the neighbor BDR address.

Specified by:

neighborBdr in interface org.onosproject.ospf.controller.OspfNbr

Returns:

neighbor BDR address

setNeighborBdr

public void setNeighborBdr(org.onlab.packet.Ip4Address neighborBdr)

Sets the neighbor BDR address.

Specified by:

setNeighborBdr in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

neighborBdr - neighbor BDR address

routerPriority

public int routerPriority()

Gets router priority.

Specified by:

routerPriority in interface org.onosproject.ospf.controller.OspfNbr

Returns:

router priority

setRouterPriority

public void setRouterPriority(int routerPriority)

Sets router priority.

Specified by:

setRouterPriority in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

routerPriority - router priority

options

public int options()

Gets the options value.

Specified by:

options in interface org.onosproject.ospf.controller.OspfNbr

Returns:

options value

setOptions

public void setOptions(int options)

Sets the options value.

Specified by:

setOptions in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

options - options value

ddSeqNum

public long ddSeqNum()

Gets the DD sequence number.

Specified by:

ddSeqNum in interface org.onosproject.ospf.controller.OspfNbr

Returns:

DD sequence number

setDdSeqNum

public void setDdSeqNum(long ddSeqNum)

Sets the DD sequence number.

Specified by:

setDdSeqNum in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

ddSeqNum - DD sequence number

isMaster

public int isMaster()

Gets neighbor is master or not.

Specified by:

isMaster in interface org.onosproject.ospf.controller.OspfNbr

Returns:

true if neighbor is master else false

lastSentDdPacket

public org.onosproject.ospf.protocol.ospfpacket.types.DdPacket lastSentDdPacket()

Gets the last sent DD Packet.

Returns:

last sent DD Packet

setLastSentDdPacket

public void setLastSentDdPacket(org.onosproject.ospf.protocol.ospfpacket.types.DdPacket lastSentDdPacket)

Sets the last sent DD Packet.

Parameters:

lastSentDdPacket - last sent DD Packet

getLastSentLsrPacket

public org.onosproject.ospf.protocol.ospfpacket.types.LsRequest getLastSentLsrPacket()

Gets the last sent Ls Request Packet.

Returns:

last sent Ls Request Packet

setLastSentLsrPacket

public void setLastSentLsrPacket(org.onosproject.ospf.protocol.ospfpacket.types.LsRequest lastSentLsrPacket)

Sets the last sent Ls Request Packet.

Parameters:

lastSentLsrPacket - last sent Ls Request Packet

getState

public org.onosproject.ospf.controller.OspfNeighborState getState()

Gets the neighbors state.

Specified by:

getState in interface org.onosproject.ospf.controller.OspfNbr

Returns:

neighbors state

setState

public void setState(org.onosproject.ospf.controller.OspfNeighborState state)

Sets the neighbors state.

Parameters:

state - neighbors state

setIsMaster

public void setIsMaster(int isMaster)

Sets neighbor is master or not.

Specified by:

setIsMaster in interface org.onosproject.ospf.controller.OspfNbr

Parameters:

isMaster - neighbor is master or not

getLsReqList

public Hashtable getLsReqList()

Gets the ls request list.

Specified by:

getLsReqList in interface org.onosproject.ospf.controller.OspfNbr

Returns:

ls request list

getReTxList

public Map getReTxList()

Gets the reTxList instance.

Specified by:

getReTxList in interface org.onosproject.ospf.controller.OspfNbr

Returns:

reTxList instance

getPendingReTxList

public Map<String,org.onosproject.ospf.controller.OspfLsa> getPendingReTxList()

Gets the pending re transmit list.

Specified by:

getPendingReTxList in interface org.onosproject.ospf.controller.OspfNbr

Returns:

pendingReTxList instance