org.onosproject.lisp.ctl

Interface LispRouter

All Known Implementing Classes:

AbstractLispRouter, DefaultLispRouter

public interface LispRouter

Represents to provider facing side of a router.

Method Summary

Modifier and Type	Method and Description
String	channelId() Identifies the channel used to communicate with the router.
boolean	connectRouter() Announces to the LISP agent that this router has connected.
org.onosproject.net.Device.Type	deviceType() Returns the router device type.
void	disconnectRouter() Disconnects the router by closing UDP connection.
List<LispEidRecord>	getEidRecords() Obtains a collection of EID records that associated with this router.
void	handleMessage(LispMessage msg) Handles the LISP control message from the channel.
boolean	isConnected() Checks if the router is connected.
boolean	isSubscribed() Checks if the router is subscribed.
org.onlab.packet.IpAddress	routerId() Obtains an IpAddress version of the ID for this router.
void	sendMessage(LispMessage msg) Writes the LISP control message to the channel.
void	setAgent(LispRouterAgent agent) Sets the LISP agent to be used.
void	setChannel(io.netty.channel.Channel channel) Sets the associated Netty channel for this router.
void	setConnected(boolean connected) Sets whether the router is connected.
void	setEidRecords(List<LispEidRecord> records) Associates the EID records to this router.
void	setSubscribed(boolean subscribed) Sets whether the router is subscribed.
String	stringId() Obtains a string version of the ID for this router.

Method Detail

sendMessage

void sendMessage(LispMessage msg)

Writes the LISP control message to the channel.

Parameters:

msg - the message to be written

handleMessage

void handleMessage(LispMessage msg)

Handles the LISP control message from the channel.

Parameters:

msg - the message to be handled

deviceType

org.onosproject.net.Device.Type deviceType()

Returns the router device type.

Returns:

device type

channelId

String channelId()

Identifies the channel used to communicate with the router.

Returns:

string representation of the connection to the device

setChannel

void setChannel(io.netty.channel.Channel channel)

Sets the associated Netty channel for this router.

Parameters:

channel - the Netty channel

stringId

String stringId()

Obtains a string version of the ID for this router.

Returns:

string representation of the device identifier

routerId

org.onlab.packet.IpAddress routerId()

Obtains an IpAddress version of the ID for this router.

Returns:

raw IP address of the device identifier

isConnected

boolean isConnected()

Checks if the router is connected.

Returns:

whether the router is connected

setConnected

void setConnected(boolean connected)

Sets whether the router is connected.

Parameters:

connected - whether the router is connected

isSubscribed

boolean isSubscribed()

Checks if the router is subscribed. As long as a router sends Map-Request message, we treat the router is subscribed.

Returns:

whether the router is subscribed

setSubscribed

void setSubscribed(boolean subscribed)

Sets whether the router is subscribed.

Parameters:

subscribed - whether the router is subscribed

getEidRecords

List<LispEidRecord> getEidRecords()

Obtains a collection of EID records that associated with this router.

Returns:

a collection EID records that associated with this router

setEidRecords

void setEidRecords(List<LispEidRecord> records)

Associates the EID records to this router.

Parameters:

records - a collection of EID records

setAgent

void setAgent(LispRouterAgent agent)

Sets the LISP agent to be used. This method can only be invoked once.

Parameters:

agent - the agent to set

connectRouter

boolean connectRouter()

Announces to the LISP agent that this router has connected.

Returns:

true if successful, false if duplicate router

disconnectRouter

void disconnectRouter()

Disconnects the router by closing UDP connection. Results in a call to the channel handler's close method for cleanup.