DefaultIsisNeighbor (onos-isis-ctl 1.6.0 API)

java.lang.Object
- org.onosproject.isis.controller.impl.DefaultIsisNeighbor

All Implemented Interfaces:

org.onosproject.isis.controller.IsisNeighbor
```
public class DefaultIsisNeighbor
extends Object
implements org.onosproject.isis.controller.IsisNeighbor
```
Representation of an ISIS neighbor. The first thing an ISIS 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
`DefaultIsisNeighbor(org.onosproject.isis.io.isispacket.pdu.HelloPdu helloMessage, org.onosproject.isis.controller.IsisInterface isisInterface)` Creates an instance of ISIS neighbor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`holdingTime()` Returns holding time.
`org.onlab.packet.Ip4Address`	`interfaceIp()` Returns interface IP.
`org.onosproject.isis.controller.IsisInterfaceState`	`interfaceState()` Gets the neighbor interface state.
`String`	`l1LanId()` Returns L1 lan ID.
`String`	`l2LanId()` Returns L2 lan ID.
`byte`	`localCircuitId()` Returns local circuit ID.
`int`	`localExtendedCircuitId()` Returns local extended circuit ID.
`String`	`neighborAreaId()` Returns neighbor area ID.
`void`	`neighborDown()` Called when neighbor is down.
`org.onlab.packet.MacAddress`	`neighborMacAddress()` Returns neighbor mac address.
`org.onosproject.isis.controller.IsisInterfaceState`	`neighborState()` Returns neighbor state.
`String`	`neighborSystemId()` Returns neighbor system ID.
`org.onosproject.isis.controller.IsisRouterType`	`routerType()` Returns router type.
`void`	`setHoldingTime(int holdingTime)` Sets holding time.
`void`	`setInterfaceIp(org.onlab.packet.Ip4Address interfaceIp)` Sets interface IP.
`void`	`setL1LanId(String l1LanId)` Sets L1 lan ID.
`void`	`setL2LanId(String l2LanId)` Sets L2 lan ID.
`void`	`setLocalCircuitId(byte localCircuitId)` Sets local circuit ID.
`void`	`setLocalExtendedCircuitId(int localExtendedCircuitId)` Sets local extended circuit ID.
`void`	`setNeighborAreaId(String neighborAreaId)` Sets neighbor area ID.
`void`	`setNeighborMacAddress(org.onlab.packet.MacAddress neighborMacAddress)` Sets neighbor mac address.
`void`	`setNeighborState(org.onosproject.isis.controller.IsisInterfaceState neighborState)` Sets the neighbor interface state.
`void`	`setNeighborSystemId(String neighborSystemId)` Sets neighbor system ID.
`void`	`setRouterType(org.onosproject.isis.controller.IsisRouterType routerType)` Sets router type.
`void`	`startHoldingTimeCheck()` Starts the holding time check timer.
`void`	`startInactivityTimeCheck()` Starts the inactivity timer.
`void`	`stopHoldingTimeCheck()` Stops the holding time check timer.
`void`	`stopInactivityTimeCheck()` Stops the inactivity timer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultIsisNeighbor
```
public DefaultIsisNeighbor(org.onosproject.isis.io.isispacket.pdu.HelloPdu helloMessage,
                           org.onosproject.isis.controller.IsisInterface isisInterface)
```
    Creates an instance of ISIS neighbor.
    
    Parameters:
    
    helloMessage - hello message instance
    
    isisInterface - ISIS interface instance
- Method Detail
  - localExtendedCircuitId
```
public int localExtendedCircuitId()
```
    Returns local extended circuit ID.
    
    Specified by:
    
    localExtendedCircuitId in interface org.onosproject.isis.controller.IsisNeighbor
    
    Returns:
    
    local extended circuit ID
  - setLocalExtendedCircuitId
```
public void setLocalExtendedCircuitId(int localExtendedCircuitId)
```
    Sets local extended circuit ID.
    
    Specified by:
    
    setLocalExtendedCircuitId in interface org.onosproject.isis.controller.IsisNeighbor
    
    Parameters:
    
    localExtendedCircuitId - neighbor extended circuit ID
  - neighborAreaId
```
public String neighborAreaId()
```
    Returns neighbor area ID.
    
    Returns:
    
    neighbor area ID
  - setNeighborAreaId
```
public void setNeighborAreaId(String neighborAreaId)
```
    Sets neighbor area ID.
    
    Parameters:
    
    neighborAreaId - neighbor area ID
  - neighborSystemId
```
public String neighborSystemId()
```
    Returns neighbor system ID.
    
    Specified by:
    
    neighborSystemId in interface org.onosproject.isis.controller.IsisNeighbor
    
    Returns:
    
    neighbor system ID
  - setNeighborSystemId
```
public void setNeighborSystemId(String neighborSystemId)
```
    Sets neighbor system ID.
    
    Parameters:
    
    neighborSystemId - neighbor system ID
  - interfaceIp
```
public org.onlab.packet.Ip4Address interfaceIp()
```
    Returns interface IP.
    
    Returns:
    
    interface IP
  - setInterfaceIp
```
public void setInterfaceIp(org.onlab.packet.Ip4Address interfaceIp)
```
    Sets interface IP.
    
    Parameters:
    
    interfaceIp - IP
  - neighborMacAddress
```
public org.onlab.packet.MacAddress neighborMacAddress()
```
    Returns neighbor mac address.
    
    Specified by:
    
    neighborMacAddress in interface org.onosproject.isis.controller.IsisNeighbor
    
    Returns:
    
    neighborMacAddress neighbor mac address
  - setNeighborMacAddress
```
public void setNeighborMacAddress(org.onlab.packet.MacAddress neighborMacAddress)
```
    Sets neighbor mac address.
    
    Parameters:
    
    neighborMacAddress - mac address
  - holdingTime
```
public int holdingTime()
```
    Returns holding time.
    
    Specified by:
    
    holdingTime in interface org.onosproject.isis.controller.IsisNeighbor
    
    Returns:
    
    holding time
  - setHoldingTime
```
public void setHoldingTime(int holdingTime)
```
    Sets holding time.
    
    Specified by:
    
    setHoldingTime in interface org.onosproject.isis.controller.IsisNeighbor
    
    Parameters:
    
    holdingTime - holding time
  - routerType
```
public org.onosproject.isis.controller.IsisRouterType routerType()
```
    Returns router type.
    
    Specified by:
    
    routerType in interface org.onosproject.isis.controller.IsisNeighbor
    
    Returns:
    
    router type
  - setRouterType
```
public void setRouterType(org.onosproject.isis.controller.IsisRouterType routerType)
```
    Sets router type.
    
    Parameters:
    
    routerType - router type
  - l1LanId
```
public String l1LanId()
```
    Returns L1 lan ID.
    
    Returns:
    
    L1 lan ID
  - setL1LanId
```
public void setL1LanId(String l1LanId)
```
    Sets L1 lan ID.
    
    Specified by:
    
    setL1LanId in interface org.onosproject.isis.controller.IsisNeighbor
    
    Parameters:
    
    l1LanId - L1 lan ID
  - l2LanId
```
public String l2LanId()
```
    Returns L2 lan ID.
    
    Returns:
    
    L2 lan ID
  - setL2LanId
```
public void setL2LanId(String l2LanId)
```
    Sets L2 lan ID.
    
    Specified by:
    
    setL2LanId in interface org.onosproject.isis.controller.IsisNeighbor
    
    Parameters:
    
    l2LanId - L2 lan ID
  - interfaceState
```
public org.onosproject.isis.controller.IsisInterfaceState interfaceState()
```
    Gets the neighbor interface state.
    
    Specified by:
    
    interfaceState in interface org.onosproject.isis.controller.IsisNeighbor
    
    Returns:
    
    neighbor interface state
  - setNeighborState
```
public void setNeighborState(org.onosproject.isis.controller.IsisInterfaceState neighborState)
```
    Sets the neighbor interface state.
    
    Specified by:
    
    setNeighborState in interface org.onosproject.isis.controller.IsisNeighbor
    
    Parameters:
    
    neighborState - the neighbor interface state
  - localCircuitId
```
public byte localCircuitId()
```
    Returns local circuit ID.
    
    Specified by:
    
    localCircuitId in interface org.onosproject.isis.controller.IsisNeighbor
    
    Returns:
    
    local circuit ID
  - setLocalCircuitId
```
public void setLocalCircuitId(byte localCircuitId)
```
    Sets local circuit ID.
    
    Parameters:
    
    localCircuitId - local circuit ID
  - neighborState
```
public org.onosproject.isis.controller.IsisInterfaceState neighborState()
```
    Returns neighbor state.
    
    Returns:
    
    neighbor state
  - startHoldingTimeCheck
```
public void startHoldingTimeCheck()
```
    Starts the holding time check timer.
  - stopHoldingTimeCheck
```
public void stopHoldingTimeCheck()
```
    Stops the holding time check timer.
    
    Specified by:
    
    stopHoldingTimeCheck in interface org.onosproject.isis.controller.IsisNeighbor
  - startInactivityTimeCheck
```
public void startInactivityTimeCheck()
```
    Starts the inactivity timer.
    
    Specified by:
    
    startInactivityTimeCheck in interface org.onosproject.isis.controller.IsisNeighbor
  - stopInactivityTimeCheck
```
public void stopInactivityTimeCheck()
```
    Stops the inactivity timer.
    
    Specified by:
    
    stopInactivityTimeCheck in interface org.onosproject.isis.controller.IsisNeighbor
  - neighborDown
```
public void neighborDown()
```
    Called when neighbor is down.

Class DefaultIsisNeighbor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultIsisNeighbor

Method Detail

localExtendedCircuitId

setLocalExtendedCircuitId

neighborAreaId

setNeighborAreaId

neighborSystemId

setNeighborSystemId

interfaceIp

setInterfaceIp

neighborMacAddress

setNeighborMacAddress

holdingTime

setHoldingTime

routerType

setRouterType

l1LanId

setL1LanId

l2LanId

setL2LanId

interfaceState

setNeighborState

localCircuitId

setLocalCircuitId

neighborState

startHoldingTimeCheck

stopHoldingTimeCheck

startInactivityTimeCheck

stopInactivityTimeCheck

neighborDown