org.opendaylight.protocol.pcep

Interface PCEPSession

All Superinterfaces:

AutoCloseable, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, PcepSessionState

All Known Implementing Classes:

PCEPSessionImpl

public interface PCEPSession
extends AutoCloseable, PcepSessionState

PCEP Session represents the finite state machine in PCEP, including timers and its purpose is to create a PCEP connection between PCE/PCC. Session is automatically started, when TCP connection is created, but can be stopped manually. If the session is up, it has to redirect messages to/from user. Handles also malformed messages and unknown requests.

Field Summary

Fields inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.stats.rev141006.PcepSessionState

QNAME

Method Summary

Modifier and Type	Method and Description
void	close(TerminationReason reason)
InetAddress	getRemoteAddress()
Tlvs	getRemoteTlvs()
Tlvs	localSessionCharacteristics() Returns session characteristics of the local PCEP Speaker
void	resetStats()
io.netty.util.concurrent.Future<Void>	sendMessage(Message message) Sends message from user to PCE/PCC.

Methods inherited from interface java.lang.AutoCloseable

close

Methods inherited from interface org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.stats.rev141006.PcepSessionState

getLocalPref, getMessages, getPeerPref

Methods inherited from interface org.opendaylight.yangtools.yang.binding.DataContainer

getImplementedInterface

Method Detail

sendMessage

io.netty.util.concurrent.Future<Void> sendMessage(Message message)

Sends message from user to PCE/PCC. If the user sends an Open Message, the session returns an error (open message is only allowed, when a PCEP handshake is in progress). Close message will close the session and free all the resources.

Parameters:

message - message to be sent

Returns:

Future promise which will be succeed when the message is enqueued in the socket.

close

void close(TerminationReason reason)

getRemoteTlvs

Tlvs getRemoteTlvs()

getRemoteAddress

InetAddress getRemoteAddress()

resetStats

void resetStats()

localSessionCharacteristics

Tlvs localSessionCharacteristics()

Returns session characteristics of the local PCEP Speaker

Returns:

Open message TLVs