org.onosproject.pcep.controller

Interface PcepClientController

All Known Implementing Classes:

PcepClientControllerImpl

public interface PcepClientController

Abstraction of an Pcep client 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	addEventListener(PcepEventListener listener) Register a listener for PCEP msg events.
void	addListener(PcepClientListener listener) Register a listener for meta events that occur to pcep devices.
void	addNodeListener(PcepNodeListener listener) Register a listener for PCEP msg events[carrying node descriptor details].
boolean	allocateLocalLabel(Tunnel tunnel) Allocates and downloads local labels for the given LSP.
void	closeConnectedClients() Close all connected PCC clients.
LabelStack	computeLabelStack(org.onosproject.net.Path path) Create label stack from the given path.
LinkedList<PcepValueType>	createPcepLabelStack(DefaultLabelStack labelStack, org.onosproject.net.Path path) Creates label stack for ERO object from network resource.
PcepClient	getClient(PccId pccId) Returns the actual pcc client for the given ip address.
Collection<PcepClient>	getClients() Returns list of pcc clients connected to this Pcep controller.
void	processClientMessage(PccId pccId, PcepMessage msg) Process a message and notify the appropriate listeners.
void	removeEventListener(PcepEventListener listener) Unregister a listener.
void	removeListener(PcepClientListener listener) Unregister a listener.
void	removeNodeListener(PcepNodeListener listener) Unregister a listener.
void	writeMessage(PccId pccId, PcepMessage msg) Send a message to a particular pcc client.

Method Detail

getClients

Collection<PcepClient> getClients()

Returns list of pcc clients connected to this Pcep controller.

Returns:

list of PcepClient elements

getClient

PcepClient getClient(PccId pccId)

Returns the actual pcc client for the given ip address.

Parameters:

pccId - the id of the pcc client to fetch

Returns:

the interface to this pcc client

addListener

void addListener(PcepClientListener listener)

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

Parameters:

listener - the listener to notify

removeListener

void removeListener(PcepClientListener listener)

Unregister a listener.

Parameters:

listener - the listener to unregister

addEventListener

void addEventListener(PcepEventListener listener)

Register a listener for PCEP msg events.

Parameters:

listener - the listener to notify

removeEventListener

void removeEventListener(PcepEventListener listener)

Unregister a listener.

Parameters:

listener - the listener to unregister

addNodeListener

void addNodeListener(PcepNodeListener listener)

Register a listener for PCEP msg events[carrying node descriptor details].

Parameters:

listener - the listener to notify

removeNodeListener

void removeNodeListener(PcepNodeListener listener)

Unregister a listener.

Parameters:

listener - the listener to be unregistered

writeMessage

void writeMessage(PccId pccId,
                  PcepMessage msg)

Send a message to a particular pcc client.

Parameters:

pccId - the id of the client to send message.

msg - the message to send

processClientMessage

void processClientMessage(PccId pccId,
                          PcepMessage msg)

Process a message and notify the appropriate listeners.

Parameters:

pccId - id of the client the message arrived on

msg - the message to process.

closeConnectedClients

void closeConnectedClients()

Close all connected PCC clients.

computeLabelStack

LabelStack computeLabelStack(org.onosproject.net.Path path)

Create label stack from the given path.

Parameters:

path - from which label stack is to be computed

Returns:

the label stack

allocateLocalLabel

boolean allocateLocalLabel(Tunnel tunnel)

Allocates and downloads local labels for the given LSP.

Parameters:

tunnel - for which local labels have to be assigned and downloaded

Returns:

success or failure

createPcepLabelStack

LinkedList<PcepValueType> createPcepLabelStack(DefaultLabelStack labelStack,
                                               org.onosproject.net.Path path)

Creates label stack for ERO object from network resource.

Parameters:

labelStack - label stack

path - (hop list)

Returns:

list of ERO sub-objects