org.onosproject.lisp.ctl

Interface LispController

public interface LispController

Abstraction of a LISP controller. Serves as a one stop shop for obtaining LISP devices and (un)register listeners on LISP events.

Method Summary

Modifier and Type	Method and Description
void	addMessageListener(LispMessageListener listener) Registers a listener for all LISP message types.
void	addRouterListener(LispRouterListener listener) Registers a router listener to track router status.
LispRouter	connectRouter(LispRouterId routerId) Connects to a specific LISP router.
void	disconnectRouter(LispRouterId routerId, boolean remove) Disconnects a LISP router and notify router removal event.
LispRouter	getRouter(LispRouterId routerId) Obtains the actual router for the given LispRouterId.
Iterable<LispRouter>	getRouters() Obtains all LISP routers known to this LISP controller.
Iterable<LispRouter>	getSubscribedRouters() Obtains all subscribed LISP routers known to this LISP controllers.
void	removeMessageListener(LispMessageListener listener) Unregisters a listener.
void	removeRouterListener(LispRouterListener listener) Unregisters a router listener.

Method Detail

getRouters

Iterable<LispRouter> getRouters()

Obtains all LISP routers known to this LISP controller.

Returns:

Iterable of LISP router elements

getSubscribedRouters

Iterable<LispRouter> getSubscribedRouters()

Obtains all subscribed LISP routers known to this LISP controllers.

Returns:

Iterable of LISP router elements

connectRouter

LispRouter connectRouter(LispRouterId routerId)

Connects to a specific LISP router. If the connection is established, it creates and adds the device to ONOS core as a LISP router.

Parameters:

routerId - router identifier

Returns:

LispRouter LISP router

disconnectRouter

void disconnectRouter(LispRouterId routerId,
                      boolean remove)

Disconnects a LISP router and notify router removal event.

Parameters:

routerId - router identifier

remove - true only if want to notify router removal event

getRouter

LispRouter getRouter(LispRouterId routerId)

Obtains the actual router for the given LispRouterId.

Parameters:

routerId - the router to fetch

Returns:

the interface to this router

addRouterListener

void addRouterListener(LispRouterListener listener)

Registers a router listener to track router status. (e.g., router add and removal)

Parameters:

listener - the listener to notify

removeRouterListener

void removeRouterListener(LispRouterListener listener)

Unregisters a router listener.

Parameters:

listener - the listener to unregister

addMessageListener

void addMessageListener(LispMessageListener listener)

Registers a listener for all LISP message types.

Parameters:

listener - the listener to notify

removeMessageListener

void removeMessageListener(LispMessageListener listener)

Unregisters a listener.

Parameters:

listener - the listener to unregister