org.onosproject.ospf.controller

Interface OspfNbr

public interface OspfNbr

Represents an OSPF 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.
void	badLSReq(org.jboss.netty.channel.Channel ch) An invalid request for LSA has been received.
long	ddSeqNum() Gets the DD sequence number.
java.util.Map	getLsReqList() Gets the LS request list.
java.util.Map<java.lang.String,OspfLsa>	getPendingReTxList() Gets the pending re transmit list as a map.
java.util.Map	getReTxList() Gets the reTxList instance.
OspfNeighborState	getState() Gets the neighbor's state.
int	isMaster() Gets neighbor is master or not.
boolean	isOpaqueCapable() Gets if the neighbor is opaque enabled or not.
org.onlab.packet.Ip4Address	neighborBdr() Gets the neighbor's BDR address.
org.onlab.packet.Ip4Address	neighborDr() Gets the neighbor's DR address.
org.onlab.packet.Ip4Address	neighborId() Gets neighbor's id.
org.onlab.packet.Ip4Address	neighborIpAddr() Gets the IP address of this neighbor.
int	options() Gets the options value.
int	routerPriority() Gets router priority.
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	setNeighborBdr(org.onlab.packet.Ip4Address neighborBdr) Sets the neighbor's BDR address.
void	setNeighborDr(org.onlab.packet.Ip4Address neighborDr) Sets the neighbor's DR address.
void	setNeighborId(org.onlab.packet.Ip4Address neighborId) Sets the neighbor's id.
void	setOptions(int options) Sets the options value.
void	setRouterDeadInterval(int routerDeadInterval) Sets router dead interval.
void	setRouterPriority(int routerPriority) Sets router priority.
void	startInactivityTimeCheck() Starts the inactivity timer.
void	stopFloodingTimer() Stops the flooding timer.
void	stopInactivityTimeCheck() Stops the inactivity timer.
void	stopRxMtDdTimer() Stops the Dd Retransmission executor task.
void	stopRxMtLsrTimer() Stops Ls request retransmission executor task.

Method Detail

neighborId

org.onlab.packet.Ip4Address neighborId()

Gets neighbor's id.

Returns:

neighbor's id

routerPriority

int routerPriority()

Gets router priority.

Returns:

router priority

neighborIpAddr

org.onlab.packet.Ip4Address neighborIpAddr()

Gets the IP address of this neighbor.

Returns:

the IP address of this neighbor

neighborDr

org.onlab.packet.Ip4Address neighborDr()

Gets the neighbor's DR address.

Returns:

neighbor's DR address

neighborBdr

org.onlab.packet.Ip4Address neighborBdr()

Gets the neighbor's BDR address.

Returns:

neighbor's BDR address

adjOk

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

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

Parameters:

ch - netty channel instance

getPendingReTxList

java.util.Map<java.lang.String,OspfLsa> getPendingReTxList()

Gets the pending re transmit list as a map.

Returns:

pending re transmit list as a map

setNeighborId

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

Sets the neighbor's id.

Parameters:

neighborId - neighbor's id

setNeighborBdr

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

Sets the neighbor's BDR address.

Parameters:

neighborBdr - neighbor's BDR address

setNeighborDr

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

Sets the neighbor's DR address.

Parameters:

neighborDr - neighbor's DR address

setRouterPriority

void setRouterPriority(int routerPriority)

Sets router priority.

Parameters:

routerPriority - router priority

setIsOpaqueCapable

void setIsOpaqueCapable(boolean isOpaqueCapable)

Sets the neighbor is opaque enabled or not.

Parameters:

isOpaqueCapable - true if the neighbor is opaque enabled else false

setIsMaster

void setIsMaster(int isMaster)

Sets neighbor is master or not.

Parameters:

isMaster - neighbor is master or not

ddSeqNum

long ddSeqNum()

Gets the DD sequence number.

Returns:

DD sequence number

setDdSeqNum

void setDdSeqNum(long ddSeqNum)

Sets the DD sequence number.

Parameters:

ddSeqNum - DD sequence number

isMaster

int isMaster()

Gets neighbor is master or not.

Returns:

true if neighbor is master else false

options

int options()

Gets the options value.

Returns:

options value

setOptions

void setOptions(int options)

Sets the options value.

Parameters:

options - options value

badLSReq

void badLSReq(org.jboss.netty.channel.Channel ch)

An invalid request for LSA has been received. 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 retransmission timer.

Parameters:

ch - netty channel instance

getLsReqList

java.util.Map getLsReqList()

Gets the LS request list.

Returns:

LS request list

getReTxList

java.util.Map getReTxList()

Gets the reTxList instance.

Returns:

reTxList instance

isOpaqueCapable

boolean isOpaqueCapable()

Gets if the neighbor is opaque enabled or not.

Returns:

true if the neighbor is opaque enabled else false.

getState

OspfNeighborState getState()

Gets the neighbor's state.

Returns:

neighbor's state

startInactivityTimeCheck

void startInactivityTimeCheck()

Starts the inactivity timer.

stopInactivityTimeCheck

void stopInactivityTimeCheck()

Stops the inactivity timer.

setRouterDeadInterval

void setRouterDeadInterval(int routerDeadInterval)

Sets router dead interval.

Parameters:

routerDeadInterval - router dead interval

stopFloodingTimer

void stopFloodingTimer()

Stops the flooding timer.

stopRxMtDdTimer

void stopRxMtDdTimer()

Stops the Dd Retransmission executor task.

stopRxMtLsrTimer

void stopRxMtLsrTimer()

Stops Ls request retransmission executor task.