org.onosproject.pcep.controller.driver

Interface PcepClientDriver

All Superinterfaces:

PcepClient

All Known Implementing Classes:

PcepClientImpl

public interface PcepClientDriver
extends PcepClient

Represents the driver side of an Path computation client(pcc).

Method Summary

Modifier and Type	Method and Description
boolean	connectClient() Announce to the Pcep agent that this pcc client has connected.
void	init(PccId pccId, PcepVersion pcepVersion, PcepPacketStats pktStats) Initializes the behavior.
boolean	isHandshakeComplete() Checks whether the handshake is complete.
void	removeConnectedClient() Remove this pcc client from the Pcep agent.
void	setAgent(PcepAgent agent) Sets the Pcep agent to be used.
void	setChannel(org.jboss.netty.channel.Channel channel) Sets the associated Netty channel for this pcc.
void	setConnected(boolean connected) Sets whether the pcc is connected.
void	setPcDeadTime(byte deadTime) Sets the dead time for this pcc.
void	setPcKeepAliveTime(byte keepAliveTime) Sets the keep alive time for this pcc.
void	setPcSessionId(byte sessionId) Sets the session id for this pcc.
void	setPcVersion(PcepVersion pcepVersion) Sets the PCEP version for this pcc.

Methods inherited from interface org.onosproject.pcep.controller.PcepClient

addNode, addSyncMsgToList, capability, channelId, delegationInfo, deleteNode, disconnectClient, factory, getPccId, getStringId, getSyncMsgList, handleMessage, initializeSyncMsgList, isConnected, isOptical, labelDbSyncStatus, lspDbSyncStatus, removeSyncMsgList, sendMessage, sendMessage, setCapability, setLabelDbSyncStatus, setLspAndDelegationInfo, setLspDbSyncStatus

Method Detail

setAgent

void setAgent(PcepAgent agent)

Sets the Pcep agent to be used. This method can only be called once.

Parameters:

agent - the agent to set.

connectClient

boolean connectClient()

Announce to the Pcep agent that this pcc client has connected.

Returns:

true if successful, false if duplicate switch.

removeConnectedClient

void removeConnectedClient()

Remove this pcc client from the Pcep agent.

setPcVersion

void setPcVersion(PcepVersion pcepVersion)

Sets the PCEP version for this pcc.

Parameters:

pcepVersion - the version to set.

setChannel

void setChannel(org.jboss.netty.channel.Channel channel)

Sets the associated Netty channel for this pcc.

Parameters:

channel - the Netty channel

setPcKeepAliveTime

void setPcKeepAliveTime(byte keepAliveTime)

Sets the keep alive time for this pcc.

Parameters:

keepAliveTime - the keep alive time to set.

setPcDeadTime

void setPcDeadTime(byte deadTime)

Sets the dead time for this pcc.

Parameters:

deadTime - the dead timer value to set.

setPcSessionId

void setPcSessionId(byte sessionId)

Sets the session id for this pcc.

Parameters:

sessionId - the session id value to set.

setConnected

void setConnected(boolean connected)

Sets whether the pcc is connected.

Parameters:

connected - whether the pcc is connected

init

void init(PccId pccId,
          PcepVersion pcepVersion,
          PcepPacketStats pktStats)

Initializes the behavior.

Parameters:

pccId - id of pcc

pcepVersion - Pcep version

pktStats - Pcep Packet Stats

isHandshakeComplete

boolean isHandshakeComplete()

Checks whether the handshake is complete.

Returns:

true is finished, false if not.