org.onosproject.pcep.api

Interface PcepController

All Known Implementing Classes:

PcepControllerImpl

public interface PcepController

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

Method Summary

Modifier and Type	Method and Description
void	addLinkListener(PcepLinkListener listener) Register a listener for meta events that occur to PCEP links.
void	addListener(PcepSwitchListener listener) Register a listener for meta events that occur to PCEP devices.
void	addTunnelListener(PcepTunnelListener listener) Register a listener for meta events that occur to PCEP tunnel.
PcepTunnel	applyTunnel(org.onosproject.net.DeviceId srcDid, org.onosproject.net.DeviceId dstDid, long srcPort, long dstPort, long bandwidth, String name) Setup a tunnel through pcep controller.
Boolean	deleteTunnel(String id) Delete tunnel by id.
PcepSwitch	getSwitch(PcepDpid did) Return a switch with a specified did.
Iterable<PcepSwitch>	getSwitches() Returns all switches known to this PCEP controller.
void	getTunnelStatistics(String pcepTunnelId) Send statistic request by tunnel id.
void	removeLinkListener(PcepLinkListener listener) Unregister a link listener.
void	removeListener(PcepSwitchListener listener) Unregister a listener.
void	removeTunnelListener(PcepTunnelListener listener) Unregister a tunnel listener.
Boolean	updateTunnelBandwidth(String id, long bandwidth) Update tunnel bandwidth by tunnel id.

Method Detail

getSwitches

Iterable<PcepSwitch> getSwitches()

Returns all switches known to this PCEP controller.

Returns:

Iterable of did elements

getSwitch

PcepSwitch getSwitch(PcepDpid did)

Return a switch with a specified did.

Parameters:

did - of a device

Returns:

a pcep device

addListener

void addListener(PcepSwitchListener listener)

Register a listener for meta events that occur to PCEP devices.

Parameters:

listener - the listener to notify

removeListener

void removeListener(PcepSwitchListener listener)

Unregister a listener.

Parameters:

listener - the listener to unregister

addLinkListener

void addLinkListener(PcepLinkListener listener)

Register a listener for meta events that occur to PCEP links.

Parameters:

listener - the listener to notify

removeLinkListener

void removeLinkListener(PcepLinkListener listener)

Unregister a link listener.

Parameters:

listener - the listener to unregister

addTunnelListener

void addTunnelListener(PcepTunnelListener listener)

Register a listener for meta events that occur to PCEP tunnel.

Parameters:

listener - the listener to notify

removeTunnelListener

void removeTunnelListener(PcepTunnelListener listener)

Unregister a tunnel listener.

Parameters:

listener - the listener to unregister

applyTunnel

PcepTunnel applyTunnel(org.onosproject.net.DeviceId srcDid,
                       org.onosproject.net.DeviceId dstDid,
                       long srcPort,
                       long dstPort,
                       long bandwidth,
                       String name)

Setup a tunnel through pcep controller.

Parameters:

srcDid - src deviceId of tunnel

dstDid - dst deviceId of tunnel

srcPort - src port

dstPort - dst port

bandwidth - andwidth of tunnel

name - tunnel name

Returns:

pcep tunnel

deleteTunnel

Boolean deleteTunnel(String id)

Delete tunnel by id.

Parameters:

id - pcep tunnel id.

Returns:

true or false

updateTunnelBandwidth

Boolean updateTunnelBandwidth(String id,
                              long bandwidth)

Update tunnel bandwidth by tunnel id.

Parameters:

id - tunnel id

bandwidth - bandwidth of a tunnel

Returns:

true or false

getTunnelStatistics

void getTunnelStatistics(String pcepTunnelId)

Send statistic request by tunnel id.

Parameters:

pcepTunnelId - PCEP tunnel id