org.onosproject.ospf.controller.impl

Class OspfInterfaceChannelHandler

java.lang.Object

org.jboss.netty.channel.SimpleChannelHandler

org.jboss.netty.handler.timeout.IdleStateAwareChannelHandler

org.onosproject.ospf.controller.impl.OspfInterfaceChannelHandler

All Implemented Interfaces:

org.jboss.netty.channel.ChannelDownstreamHandler, org.jboss.netty.channel.ChannelHandler, org.jboss.netty.channel.ChannelUpstreamHandler

public class OspfInterfaceChannelHandler
extends org.jboss.netty.handler.timeout.IdleStateAwareChannelHandler

Channel handler deals with the OSPF channel connection. Also it dispatches messages to the appropriate handlers.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

org.jboss.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
OspfInterfaceChannelHandler()
OspfInterfaceChannelHandler(Controller controller, org.onosproject.ospf.controller.OspfArea ospfArea, org.onosproject.ospf.controller.OspfInterface ospfInterface) Creates an instance of OSPF channel handler.

Method Summary

Modifier and Type	Method and Description
void	addDeviceInformation(org.onosproject.ospf.controller.OspfRouter ospfRouter) Adds device information.
void	addLinkInformation(org.onosproject.ospf.controller.OspfRouter ospfRouter, org.onosproject.ospf.controller.OspfLinkTed ospfLinkTed) Adds link information.
void	backupSeen(org.jboss.netty.channel.Channel ch) Gets called when a BDR was detected before the wait timer expired.
List<OspfEligibleRouter>	calculateListOfEligibleRouters(OspfEligibleRouter electedDr) BDR Election process.
void	channelConnected(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ChannelStateEvent evt)
void	channelDisconnected(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ChannelStateEvent evt)
boolean	compareDdPackets(org.onosproject.ospf.protocol.ospfpacket.types.DdPacket receivedDPacket, org.onosproject.ospf.protocol.ospfpacket.types.DdPacket lastDdPacket) Compares two Dd Packets to check whether its duplicate or not.
OspfEligibleRouter	electBdr(List<OspfEligibleRouter> eligibleRouters) Based on router priority assigns BDR.
OspfEligibleRouter	electDr(List<OspfEligibleRouter> eligibleRouters, OspfEligibleRouter electedBdr) DR Election process.
void	electRouter(org.jboss.netty.channel.Channel ch) Performs DR election.
void	exceptionCaught(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.ExceptionEvent e)
void	interfaceDown() Gets called when an interface is down.
void	interfaceUp() Represents an interface is up and connected.
void	messageReceived(org.jboss.netty.channel.ChannelHandlerContext ctx, org.jboss.netty.channel.MessageEvent e)
void	neighborChange() Neighbor change event is triggered when the router priority gets changed.
void	processOspfMessage(org.onosproject.ospf.protocol.ospfpacket.OspfMessage ospfMessage, org.jboss.netty.channel.ChannelHandlerContext ctx) When an OSPF message received it is handed over to this method.
void	removeDeviceInformation(org.onosproject.ospf.controller.OspfRouter ospfRouter) removes device information.
void	removeLinkInformation(org.onosproject.ospf.controller.OspfNbr ospfNbr) Removes link information.
OspfEligibleRouter	selectRouterBasedOnPriority(List<OspfEligibleRouter> routersList) DR election process.
void	waitTimer(org.jboss.netty.channel.Channel ch) Gets called when no hello message received for particular period.

Methods inherited from class org.jboss.netty.handler.timeout.IdleStateAwareChannelHandler

channelIdle, handleUpstream

Methods inherited from class org.jboss.netty.channel.SimpleChannelHandler

bindRequested, channelBound, channelClosed, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, closeRequested, connectRequested, disconnectRequested, handleDownstream, setInterestOpsRequested, unbindRequested, writeComplete, writeRequested

Methods inherited from class java.lang.Object

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

Constructor Detail

OspfInterfaceChannelHandler

public OspfInterfaceChannelHandler()

OspfInterfaceChannelHandler

public OspfInterfaceChannelHandler(Controller controller,
                                   org.onosproject.ospf.controller.OspfArea ospfArea,
                                   org.onosproject.ospf.controller.OspfInterface ospfInterface)

Creates an instance of OSPF channel handler.

Parameters:

controller - controller instance

ospfArea - ospf area instance

ospfInterface - ospf interface instance

Method Detail

interfaceUp

public void interfaceUp()
                 throws Exception

Represents an interface is up and connected.

Throws:

Exception - might throws exception

backupSeen

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

Gets called when a BDR was detected before the wait timer expired.

Parameters:

ch - channel instance

Throws:

Exception - might throws exception

waitTimer

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

Gets called when no hello message received for particular period.

Parameters:

ch - channel instance

Throws:

Exception - might throws exception

neighborChange

public void neighborChange()
                    throws Exception

Neighbor change event is triggered when the router priority gets changed.

Throws:

Exception - might throws exception

interfaceDown

public void interfaceDown()

Gets called when an interface is down. All interface variables are reset, and interface timers disabled. Also all neighbor connections associated with the interface are destroyed.

channelConnected

public void channelConnected(org.jboss.netty.channel.ChannelHandlerContext ctx,
                             org.jboss.netty.channel.ChannelStateEvent evt)
                      throws Exception

Overrides:

channelConnected in class org.jboss.netty.channel.SimpleChannelHandler

Throws:

Exception

channelDisconnected

public void channelDisconnected(org.jboss.netty.channel.ChannelHandlerContext ctx,
                                org.jboss.netty.channel.ChannelStateEvent evt)

Overrides:

channelDisconnected in class org.jboss.netty.channel.SimpleChannelHandler

exceptionCaught

public void exceptionCaught(org.jboss.netty.channel.ChannelHandlerContext ctx,
                            org.jboss.netty.channel.ExceptionEvent e)
                     throws Exception

Overrides:

exceptionCaught in class org.jboss.netty.channel.SimpleChannelHandler

Throws:

Exception

messageReceived

public void messageReceived(org.jboss.netty.channel.ChannelHandlerContext ctx,
                            org.jboss.netty.channel.MessageEvent e)
                     throws Exception

Overrides:

messageReceived in class org.jboss.netty.channel.SimpleChannelHandler

Throws:

Exception

processOspfMessage

public void processOspfMessage(org.onosproject.ospf.protocol.ospfpacket.OspfMessage ospfMessage,
                               org.jboss.netty.channel.ChannelHandlerContext ctx)
                        throws Exception

When an OSPF message received it is handed over to this method. Based on the type of the OSPF message received it will be handed over to corresponding message handler methods.

Parameters:

ospfMessage - received OSPF message

ctx - channel handler context instance.

Throws:

Exception - might throws exception

compareDdPackets

public boolean compareDdPackets(org.onosproject.ospf.protocol.ospfpacket.types.DdPacket receivedDPacket,
                                org.onosproject.ospf.protocol.ospfpacket.types.DdPacket lastDdPacket)

Compares two Dd Packets to check whether its duplicate or not.

Parameters:

receivedDPacket - received DD packet from network.

lastDdPacket - Last DdPacket which we sent.

Returns:

true if it is a duplicate packet else false.

electRouter

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

Performs DR election.

Parameters:

ch - Netty Channel instance.

Throws:

Exception - might throws exception

calculateListOfEligibleRouters

public List<OspfEligibleRouter> calculateListOfEligibleRouters(OspfEligibleRouter electedDr)

BDR Election process. Find the list of eligible router to participate in the process.

Parameters:

electedDr - router elected as DR.

Returns:

list of eligible routers

electBdr

public OspfEligibleRouter electBdr(List<OspfEligibleRouter> eligibleRouters)

Based on router priority assigns BDR.

Parameters:

eligibleRouters - list of routers to participate in bdr election.

Returns:

OSPF Eligible router instance.

electDr

public OspfEligibleRouter electDr(List<OspfEligibleRouter> eligibleRouters,
                                  OspfEligibleRouter electedBdr)

DR Election process.

Parameters:

eligibleRouters - list of eligible routers.

electedBdr - Elected Bdr, OSPF eligible router instance.

Returns:

OSPF eligible router instance.

selectRouterBasedOnPriority

public OspfEligibleRouter selectRouterBasedOnPriority(List<OspfEligibleRouter> routersList)

DR election process.

Parameters:

routersList - list of eligible routers.

Returns:

OSPF eligible router instance.

addDeviceInformation

public void addDeviceInformation(org.onosproject.ospf.controller.OspfRouter ospfRouter)

Adds device information.

Parameters:

ospfRouter - OSPF router instance

removeDeviceInformation

public void removeDeviceInformation(org.onosproject.ospf.controller.OspfRouter ospfRouter)

removes device information.

Parameters:

ospfRouter - OSPF neighbor instance

addLinkInformation

public void addLinkInformation(org.onosproject.ospf.controller.OspfRouter ospfRouter,
                               org.onosproject.ospf.controller.OspfLinkTed ospfLinkTed)

Adds link information.

Parameters:

ospfRouter - OSPF router instance

ospfLinkTed - list link ted instances

removeLinkInformation

public void removeLinkInformation(org.onosproject.ospf.controller.OspfNbr ospfNbr)

Removes link information.

Parameters:

ospfNbr - OSPF neighbor instance