OspfInterface (onos-protocols-ospf-api)

```
public interface OspfInterface
```
Represents an OSPF Interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addNeighbouringRouter(OspfNbr ospfNbr)` Adds the given neighboring router to the neighbor map.
`org.onlab.packet.Ip4Address`	`bdr()` Gets the IP address of the BDR.
`org.onlab.packet.Ip4Address`	`dr()` Gets the ip address of the DR..
`int`	`helloIntervalTime()` Gets hello interval time in seconds, this defines how often we send the hello packet.
`void`	`interfaceDown()` Gets called when an interface is down.
`int`	`interfaceIndex()` Returns interface index.
`int`	`interfaceType()` Gets the interface type.
`void`	`interfaceUp()` Represents an interface is up and connected.
`org.onlab.packet.Ip4Address`	`ipAddress()` Gets the IP address.
`org.onlab.packet.Ip4Address`	`ipNetworkMask()` Gets network mask of the interface.
`boolean`	`isNeighborInList(java.lang.String neighborId)` Checks the given neighbor is in the neighbor list.
`java.util.Map<java.lang.String,OspfNbr>`	`listOfNeighbors()` Gets the list of neighbors associated with the interface.
`int`	`mtu()` Gets the MTU.
`OspfNbr`	`neighbouringRouter(java.lang.String neighborId)` Gets the neighbor instance from listOfNeighbors map for the given neighbor ID.
`OspfArea`	`ospfArea()` Returns OSPF area instance.
`void`	`processOspfMessage(OspfMessage ospfMessage, org.jboss.netty.channel.ChannelHandlerContext ctx)` When an OSPF message received it is handed over to this method.
`void`	`removeLsaFromNeighborMap(java.lang.String lsaKey)` Removes LSA headers from the map in which LSA headers are stored.
`void`	`removeNeighbors()` Removes all the neighbors.
`int`	`reTransmitInterval()` Gets retransmit interval.
`int`	`routerDeadIntervalTime()` Gets router dead interval time.
`int`	`routerPriority()` Gets router priority.
`void`	`setBdr(org.onlab.packet.Ip4Address bdr)` Sets the value of BDR.
`void`	`setDr(org.onlab.packet.Ip4Address dr)` Sets the value of DR.
`void`	`setHelloIntervalTime(int helloIntervalTime)` Sets the hello interval time.
`void`	`setInterfaceIndex(int interfaceIndex)` Sets interface index.
`void`	`setInterfaceType(int interfaceType)` Sets interface type.
`void`	`setIpAddress(org.onlab.packet.Ip4Address ipAddress)` Sets IP Address of this interface.
`void`	`setIpNetworkMask(org.onlab.packet.Ip4Address ipNetworkMask)` Sets IP network mask.
`void`	`setMtu(int mtu)` Sets MTU.
`void`	`setOspfArea(OspfArea ospfArea)` Sets OSPF area instance.
`void`	`setReTransmitInterval(int reTransmitInterval)` Sets retransmit interval which indicates the number of seconds between LSA retransmissions.
`void`	`setRouterDeadIntervalTime(int routerDeadIntervalTime)` Sets router dead interval time.
`void`	`setRouterPriority(int routerPriority)` Sets router priority.
`void`	`startDelayedAckTimer()` Starts the timer which waits for configured seconds and sends Delayed Ack Packet.
`void`	`startHelloTimer()` Starts the hello timer which sends hello packet every configured seconds.
`void`	`stopDelayedAckTimer()` Stops the delayed acknowledge timer.
`void`	`stopHelloTimer()` Stops the hello timer.

- Method Detail
  - interfaceIndex
```
int interfaceIndex()
```
    Returns interface index.
    
    Returns:
    
    interface index
  - setInterfaceIndex
```
void setInterfaceIndex(int interfaceIndex)
```
    Sets interface index.
    
    Parameters:
    
    interfaceIndex - interface index
  - ospfArea
```
OspfArea ospfArea()
```
    Returns OSPF area instance.
    
    Returns:
    
    OSPF area instance
  - setOspfArea
```
void setOspfArea(OspfArea ospfArea)
```
    Sets OSPF area instance.
    
    Parameters:
    
    ospfArea - OSPF area instance
  - ipNetworkMask
```
org.onlab.packet.Ip4Address ipNetworkMask()
```
    Gets network mask of the interface.
    
    Returns:
    
    network mask
  - setBdr
```
void setBdr(org.onlab.packet.Ip4Address bdr)
```
    Sets the value of BDR. The BDR is calculated during adjacency formation.
    
    Parameters:
    
    bdr - backup designated router's IP address
  - setDr
```
void setDr(org.onlab.packet.Ip4Address dr)
```
    Sets the value of DR. The DR is calculated during adjacency formation.
    
    Parameters:
    
    dr - designated router's IP address
  - setHelloIntervalTime
```
void setHelloIntervalTime(int helloIntervalTime)
```
    Sets the hello interval time. It is the interval at which a hello packet is sent out via this interface.
    
    Parameters:
    
    helloIntervalTime - an integer interval time
  - setRouterDeadIntervalTime
```
void setRouterDeadIntervalTime(int routerDeadIntervalTime)
```
    Sets router dead interval time. This is the interval after which this interface will trigger a process to kill neighbor.
    
    Parameters:
    
    routerDeadIntervalTime - an integer interval time
  - setInterfaceType
```
void setInterfaceType(int interfaceType)
```
    Sets interface type. This indicates whether the interface is on point to point mode or broadcast mode.
    
    Parameters:
    
    interfaceType - an integer represents interface type
  - setIpAddress
```
void setIpAddress(org.onlab.packet.Ip4Address ipAddress)
```
    Sets IP Address of this interface.
    
    Parameters:
    
    ipAddress - IP address
  - setIpNetworkMask
```
void setIpNetworkMask(org.onlab.packet.Ip4Address ipNetworkMask)
```
    Sets IP network mask.
    
    Parameters:
    
    ipNetworkMask - network mask
  - setReTransmitInterval
```
void setReTransmitInterval(int reTransmitInterval)
```
    Sets retransmit interval which indicates the number of seconds between LSA retransmissions.
    
    Parameters:
    
    reTransmitInterval - an integer represents interval
  - setMtu
```
void setMtu(int mtu)
```
    Sets MTU.
    
    Parameters:
    
    mtu - an integer represents max transfer unit
  - setRouterPriority
```
void setRouterPriority(int routerPriority)
```
    Sets router priority.
    
    Parameters:
    
    routerPriority - value
  - ipAddress
```
org.onlab.packet.Ip4Address ipAddress()
```
    Gets the IP address.
    
    Returns:
    
    an string represents IP address
  - interfaceType
```
int interfaceType()
```
    Gets the interface type.
    
    Returns:
    
    an integer represents interface type
  - mtu
```
int mtu()
```
    Gets the MTU.
    
    Returns:
    
    an integer representing max transfer unit
  - listOfNeighbors
```
java.util.Map<java.lang.String,OspfNbr> listOfNeighbors()
```
    Gets the list of neighbors associated with the interface.
    
    Returns:
    
    listOfNeighbors as key value pair
  - bdr
```
org.onlab.packet.Ip4Address bdr()
```
    Gets the IP address of the BDR.
    
    Returns:
    
    bdr BDR's IP address
  - dr
```
org.onlab.packet.Ip4Address dr()
```
    Gets the ip address of the DR..
    
    Returns:
    
    dr DR's IP address
  - helloIntervalTime
```
int helloIntervalTime()
```
    Gets hello interval time in seconds, this defines how often we send the hello packet.
    
    Returns:
    
    hello interval time in seconds
  - reTransmitInterval
```
int reTransmitInterval()
```
    Gets retransmit interval.
    
    Returns:
    
    reTransmitInterval an integer represents interval
  - routerDeadIntervalTime
```
int routerDeadIntervalTime()
```
    Gets router dead interval time. This defines how long we should wait for hello packets before we declare the neighbor is dead.
    
    Returns:
    
    routerDeadIntervalTime an integer interval time
  - routerPriority
```
int routerPriority()
```
    Gets router priority.
    
    Returns:
    
    routerPriority value
  - addNeighbouringRouter
```
void addNeighbouringRouter(OspfNbr ospfNbr)
```
    Adds the given neighboring router to the neighbor map.
    
    Parameters:
    
    ospfNbr - neighbor instance
  - neighbouringRouter
```
OspfNbr neighbouringRouter(java.lang.String neighborId)
```
    Gets the neighbor instance from listOfNeighbors map for the given neighbor ID.
    
    Parameters:
    
    neighborId - neighbors id
    
    Returns:
    
    ospfNbr neighbor instance
  - isNeighborInList
```
boolean isNeighborInList(java.lang.String neighborId)
```
    Checks the given neighbor is in the neighbor list.
    
    Parameters:
    
    neighborId - neighbors id
    
    Returns:
    
    true if neighbor in list else false
  - removeLsaFromNeighborMap
```
void removeLsaFromNeighborMap(java.lang.String lsaKey)
```
    Removes LSA headers from the map in which LSA headers are stored.
    
    Parameters:
    
    lsaKey - key used to store lsa in map
  - processOspfMessage
```
void processOspfMessage(OspfMessage ospfMessage,
                        org.jboss.netty.channel.ChannelHandlerContext ctx)
```
    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.
  - interfaceUp
```
void interfaceUp()
```
    Represents an interface is up and connected.
  - startDelayedAckTimer
```
void startDelayedAckTimer()
```
    Starts the timer which waits for configured seconds and sends Delayed Ack Packet.
  - stopDelayedAckTimer
```
void stopDelayedAckTimer()
```
    Stops the delayed acknowledge timer.
  - startHelloTimer
```
void startHelloTimer()
```
    Starts the hello timer which sends hello packet every configured seconds.
  - stopHelloTimer
```
void stopHelloTimer()
```
    Stops the hello timer.
  - interfaceDown
```
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.
  - removeNeighbors
```
void removeNeighbors()
```
    Removes all the neighbors.

Interface OspfInterface

Method Summary

Method Detail

interfaceIndex

setInterfaceIndex

ospfArea

setOspfArea

ipNetworkMask

setBdr

setDr

setHelloIntervalTime

setRouterDeadIntervalTime

setInterfaceType

setIpAddress

setIpNetworkMask

setReTransmitInterval

setMtu

setRouterPriority

ipAddress

interfaceType

mtu

listOfNeighbors

bdr

dr

helloIntervalTime

reTransmitInterval

routerDeadIntervalTime

routerPriority

addNeighbouringRouter

neighbouringRouter

isNeighborInList

removeLsaFromNeighborMap

processOspfMessage

interfaceUp

startDelayedAckTimer

stopDelayedAckTimer

startHelloTimer

stopHelloTimer

interfaceDown

removeNeighbors