IsisInterface (onos-providers-isis-cfg)

```
public interface IsisInterface
```
Representation of an ISIS interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`areaAddress()` Returns area address.
`String`	`circuitId()` Returns circuit ID.
`int`	`helloInterval()` Returns hello interval.
`int`	`holdingTime()` Returns holding time.
`int`	`interfaceIndex()` Returns interface index.
`org.onlab.packet.Ip4Address`	`interfaceIpAddress()` Returns the interface IP address.
`IsisInterfaceState`	`interfaceState()` Returns the interface state.
`String`	`intermediateSystemName()` Returns intermediate system name.
`IsisLsdb`	`isisLsdb()` Returns the LSDB instance.
`String`	`l1LanId()` Returns LAN ID.
`String`	`l2LanId()` Returns LAN ID.
`IsisNeighbor`	`lookup(org.onlab.packet.MacAddress isisNeighborMac)` Returns the ISIS neighbor instance if exists.
`Set<org.onlab.packet.MacAddress>`	`neighbors()` Returns the neighbors list.
`byte[]`	`networkMask()` Returns the network mask.
`IsisNetworkType`	`networkType()` Returns point to point or broadcast.
`int`	`priority()` Returns priority.
`void`	`processIsisMessage(IsisMessage isisMessage, IsisLsdb isisLsdb, org.jboss.netty.channel.Channel channel)` Processes an ISIS message which is received on this interface.
`void`	`removeNeighbor(IsisNeighbor isisNeighbor)` Removes neighbor from the interface neighbor map.
`void`	`removeNeighbors()` Removes all the neighbors.
`int`	`reservedPacketCircuitType()` Returns reserved packet circuit type.
`void`	`setAreaAddress(String areaAddress)` Sets area address.
`void`	`setAreaLength(int areaLength)` Sets area length.
`void`	`setCircuitId(String circuitId)` Sets circuit ID.
`void`	`setHelloInterval(int helloInterval)` Sets hello interval.
`void`	`setHoldingTime(int holdingTime)` Sets holding time.
`void`	`setIdLength(int idLength)` Sets ID length.
`void`	`setInterfaceIndex(int interfaceIndex)` Sets interface index.
`void`	`setInterfaceIpAddress(org.onlab.packet.Ip4Address interfaceIpAddress)` Sets the interface IP address.
`void`	`setInterfaceMacAddress(org.onlab.packet.MacAddress interfaceMacAddress)` Sets the interface MAC address.
`void`	`setInterfaceState(IsisInterfaceState interfaceState)` Sets the interface state.
`void`	`setIntermediateSystemName(String intermediateSystemName)` Sets intermediate system name.
`void`	`setL1LanId(String lanId)` Sets LAN ID.
`void`	`setL2LanId(String lanId)` Sets LAN ID.
`void`	`setMaxAreaAddresses(int maxAreaAddresses)` Sets max area addresses.
`void`	`setNetworkMask(byte[] networkMask)` Sets the network mask.
`void`	`setNetworkType(IsisNetworkType networkType)` Sets point to point.
`void`	`setPriority(int priority)` Sets priority.
`void`	`setReservedPacketCircuitType(int reservedPacketCircuitType)` Sets reserved packet circuit type.
`void`	`setSystemId(String systemId)` Sets system ID.
`void`	`startHelloSender(org.jboss.netty.channel.Channel channel)` Starts the hello timer which sends hello packet every configured seconds.
`void`	`stopHelloSender()` Stops the hello timer which sends hello packet every configured seconds.
`String`	`systemId()` Returns system ID.

- Method Detail
  - interfaceIndex
```
int interfaceIndex()
```
    Returns interface index.
    
    Returns:
    
    interface index
  - setInterfaceIndex
```
void setInterfaceIndex(int interfaceIndex)
```
    Sets interface index.
    
    Parameters:
    
    interfaceIndex - interface index
  - interfaceIpAddress
```
org.onlab.packet.Ip4Address interfaceIpAddress()
```
    Returns the interface IP address.
    
    Returns:
    
    interface IP address
  - setInterfaceIpAddress
```
void setInterfaceIpAddress(org.onlab.packet.Ip4Address interfaceIpAddress)
```
    Sets the interface IP address.
    
    Parameters:
    
    interfaceIpAddress - interface IP address interface IP address
  - networkMask
```
byte[] networkMask()
```
    Returns the network mask.
    
    Returns:
    
    network mask
  - setNetworkMask
```
void setNetworkMask(byte[] networkMask)
```
    Sets the network mask.
    
    Parameters:
    
    networkMask - network mask
  - setInterfaceMacAddress
```
void setInterfaceMacAddress(org.onlab.packet.MacAddress interfaceMacAddress)
```
    Sets the interface MAC address.
    
    Parameters:
    
    interfaceMacAddress - interface MAC address
  - neighbors
```
Set<org.onlab.packet.MacAddress> neighbors()
```
    Returns the neighbors list.
    
    Returns:
    
    neighbors list
  - setIntermediateSystemName
```
void setIntermediateSystemName(String intermediateSystemName)
```
    Sets intermediate system name.
    
    Parameters:
    
    intermediateSystemName - intermediate system name
  - systemId
```
String systemId()
```
    Returns system ID.
    
    Returns:
    
    systemID system ID
  - setSystemId
```
void setSystemId(String systemId)
```
    Sets system ID.
    
    Parameters:
    
    systemId - system ID
  - l1LanId
```
String l1LanId()
```
    Returns LAN ID.
    
    Returns:
    
    LAN ID
  - setL1LanId
```
void setL1LanId(String lanId)
```
    Sets LAN ID.
    
    Parameters:
    
    lanId - LAN ID
  - l2LanId
```
String l2LanId()
```
    Returns LAN ID.
    
    Returns:
    
    LAN ID
  - setL2LanId
```
void setL2LanId(String lanId)
```
    Sets LAN ID.
    
    Parameters:
    
    lanId - LAN ID
  - setIdLength
```
void setIdLength(int idLength)
```
    Sets ID length.
    
    Parameters:
    
    idLength - ID length
  - setMaxAreaAddresses
```
void setMaxAreaAddresses(int maxAreaAddresses)
```
    Sets max area addresses.
    
    Parameters:
    
    maxAreaAddresses - max area addresses
  - reservedPacketCircuitType
```
int reservedPacketCircuitType()
```
    Returns reserved packet circuit type.
    
    Returns:
    
    reserved packet circuit type
  - setReservedPacketCircuitType
```
void setReservedPacketCircuitType(int reservedPacketCircuitType)
```
    Sets reserved packet circuit type.
    
    Parameters:
    
    reservedPacketCircuitType - reserved packet circuit type
  - networkType
```
IsisNetworkType networkType()
```
    Returns point to point or broadcast.
    
    Returns:
    
    1 if point to point, 2 broadcast
  - setNetworkType
```
void setNetworkType(IsisNetworkType networkType)
```
    Sets point to point.
    
    Parameters:
    
    networkType - point to point
  - areaAddress
```
String areaAddress()
```
    Returns area address.
    
    Returns:
    
    area address
  - setAreaAddress
```
void setAreaAddress(String areaAddress)
```
    Sets area address.
    
    Parameters:
    
    areaAddress - area address
  - setAreaLength
```
void setAreaLength(int areaLength)
```
    Sets area length.
    
    Parameters:
    
    areaLength - area length
  - holdingTime
```
int holdingTime()
```
    Returns holding time.
    
    Returns:
    
    holding time
  - setHoldingTime
```
void setHoldingTime(int holdingTime)
```
    Sets holding time.
    
    Parameters:
    
    holdingTime - holding time
  - priority
```
int priority()
```
    Returns priority.
    
    Returns:
    
    priority
  - setPriority
```
void setPriority(int priority)
```
    Sets priority.
    
    Parameters:
    
    priority - priority
  - helloInterval
```
int helloInterval()
```
    Returns hello interval.
    
    Returns:
    
    hello interval
  - setHelloInterval
```
void setHelloInterval(int helloInterval)
```
    Sets hello interval.
    
    Parameters:
    
    helloInterval - hello interval
  - startHelloSender
```
void startHelloSender(org.jboss.netty.channel.Channel channel)
```
    Starts the hello timer which sends hello packet every configured seconds.
    
    Parameters:
    
    channel - netty channel instance
  - stopHelloSender
```
void stopHelloSender()
```
    Stops the hello timer which sends hello packet every configured seconds.
  - processIsisMessage
```
void processIsisMessage(IsisMessage isisMessage,
                        IsisLsdb isisLsdb,
                        org.jboss.netty.channel.Channel channel)
```
    Processes an ISIS message which is received on this interface.
    
    Parameters:
    
    isisMessage - ISIS message instance
    
    isisLsdb - ISIS LSDB instance
    
    channel - channel instance
  - interfaceState
```
IsisInterfaceState interfaceState()
```
    Returns the interface state.
    
    Returns:
    
    interface state
  - setInterfaceState
```
void setInterfaceState(IsisInterfaceState interfaceState)
```
    Sets the interface state.
    
    Parameters:
    
    interfaceState - the interface state
  - isisLsdb
```
IsisLsdb isisLsdb()
```
    Returns the LSDB instance.
    
    Returns:
    
    LSDB instance
  - intermediateSystemName
```
String intermediateSystemName()
```
    Returns intermediate system name.
    
    Returns:
    
    intermediate system name
  - lookup
```
IsisNeighbor lookup(org.onlab.packet.MacAddress isisNeighborMac)
```
    Returns the ISIS neighbor instance if exists.
    
    Parameters:
    
    isisNeighborMac - mac address of the neighbor router
    
    Returns:
    
    ISIS neighbor instance if exists else null
  - circuitId
```
String circuitId()
```
    Returns circuit ID.
    
    Returns:
    
    circuit ID
  - setCircuitId
```
void setCircuitId(String circuitId)
```
    Sets circuit ID.
    
    Parameters:
    
    circuitId - circuit ID
  - removeNeighbor
```
void removeNeighbor(IsisNeighbor isisNeighbor)
```
    Removes neighbor from the interface neighbor map.
    
    Parameters:
    
    isisNeighbor - ISIS neighbor instance
  - removeNeighbors
```
void removeNeighbors()
```
    Removes all the neighbors.

Interface IsisInterface

Method Summary

Method Detail

interfaceIndex

setInterfaceIndex

interfaceIpAddress

setInterfaceIpAddress

networkMask

setNetworkMask

setInterfaceMacAddress

neighbors

setIntermediateSystemName

systemId

setSystemId

l1LanId

setL1LanId

l2LanId

setL2LanId

setIdLength

setMaxAreaAddresses

reservedPacketCircuitType

setReservedPacketCircuitType

networkType

setNetworkType

areaAddress

setAreaAddress

setAreaLength

holdingTime

setHoldingTime

priority

setPriority

helloInterval

setHelloInterval

startHelloSender

stopHelloSender

processIsisMessage

interfaceState

setInterfaceState

isisLsdb

intermediateSystemName

lookup

circuitId

setCircuitId

removeNeighbor

removeNeighbors