org.onosproject.ovsdb.controller

Interface OvsdbController

public interface OvsdbController

Abstraction of an ovsdb controller. Serves as an one stop shop for obtaining OvsdbNode and (un)register listeners on ovsdb events and ovsdb node events.

Method Summary

Modifier and Type	Method and Description
void	addNodeListener(OvsdbNodeListener listener) Adds Node Event Listener.
void	addOvsdbEventListener(OvsdbEventListener listener) Adds ovsdb event listener.
void	connect(org.onlab.packet.IpAddress ip, org.onlab.packet.TpPort port) Connect to the ovsdb server with given ip address and port number.
void	connect(org.onlab.packet.IpAddress ip, org.onlab.packet.TpPort port, java.util.function.Consumer<java.lang.Exception> failhandler) Connect to the ovsdb server with given ip address, port number, and connection failure handler.
java.util.List<OvsdbNodeId>	getNodeIds() Gets all the nodes information.
OvsdbClientService	getOvsdbClient(OvsdbNodeId nodeId) Gets an ovsdb client by node identifier.
void	removeNodeListener(OvsdbNodeListener listener) Removes Node Event Listener.
void	removeOvsdbEventListener(OvsdbEventListener listener) Removes ovsdb event listener.
void	setServerMode(boolean serverMode) Configure the OVSDB instance to run as a server mode.

Method Detail

addNodeListener

void addNodeListener(OvsdbNodeListener listener)

Adds Node Event Listener.

Parameters:

listener - node listener

removeNodeListener

void removeNodeListener(OvsdbNodeListener listener)

Removes Node Event Listener.

Parameters:

listener - node listener

addOvsdbEventListener

void addOvsdbEventListener(OvsdbEventListener listener)

Adds ovsdb event listener.

Parameters:

listener - event listener

removeOvsdbEventListener

void removeOvsdbEventListener(OvsdbEventListener listener)

Removes ovsdb event listener.

Parameters:

listener - event listener

getNodeIds

java.util.List<OvsdbNodeId> getNodeIds()

Gets all the nodes information.

Returns:

the list of node id

getOvsdbClient

OvsdbClientService getOvsdbClient(OvsdbNodeId nodeId)

Gets an ovsdb client by node identifier.

Parameters:

nodeId - node identifier

Returns:

OvsdbClient ovsdb node information

connect

void connect(org.onlab.packet.IpAddress ip,
             org.onlab.packet.TpPort port)

Connect to the ovsdb server with given ip address and port number.

Parameters:

ip - ip address

port - port number

connect

void connect(org.onlab.packet.IpAddress ip,
             org.onlab.packet.TpPort port,
             java.util.function.Consumer<java.lang.Exception> failhandler)

Connect to the ovsdb server with given ip address, port number, and connection failure handler.

Parameters:

ip - ip address

port - port number

failhandler - connection failure handler

setServerMode

void setServerMode(boolean serverMode)

Configure the OVSDB instance to run as a server mode. If this mode is configured as true, then OVSDB will run as both OVSDB client and server. If this mode is configured as false, then OVSDB will run as OVS client only.

Parameters:

serverMode - server mode flag