org.opendaylight.protocol.pcep.impl

Class PCEPSessionImpl

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.SimpleChannelInboundHandler<Message>

org.opendaylight.protocol.pcep.impl.PCEPSessionImpl

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler, AutoCloseable, PCEPSession, PcepSessionState, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

public class PCEPSessionImpl
extends io.netty.channel.SimpleChannelInboundHandler<Message>
implements PCEPSession

Implementation of PCEPSession. (Not final for testing.)

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
protected long	lastMessageSentAt System.nanoTime value about when was sent the last message Protected to be updated also in tests.

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	channelInactive(io.netty.channel.ChannelHandlerContext ctx)
protected void	channelRead0(io.netty.channel.ChannelHandlerContext ctx, Message msg)
void	close() Closes PCEP session without sending a Close message, as the channel is no longer active.
void	close(TerminationReason reason) Closes PCEP session, cancels all timers, returns to state Idle, sends the Close Message.
void	endOfInput()
void	exceptionCaught(io.netty.channel.ChannelHandlerContext ctx, Throwable cause)
Integer	getDeadTimerValue()
Class<? extends org.opendaylight.yangtools.yang.binding.DataContainer>	getImplementedInterface()
Integer	getKeepAliveTimerValue()
LocalPref	getLocalPref() The local (PCE) preferences.
Messages	getMessages() The statistics of PCEP received/sent messages from the PCE point of view.
PeerPref	getPeerPref() The remote peer (PCC) preferences.
InetAddress	getRemoteAddress()
Tlvs	getRemoteTlvs()
void	handleMalformedMessage(PCEPErrors error) The fact, that a message is malformed, comes from parser.
void	handleMessage(Message msg) Handles incoming message.
void	handlerAdded(io.netty.channel.ChannelHandlerContext ctx)
boolean	isClosed()
Tlvs	localSessionCharacteristics() Returns session characteristics of the local PCEP Speaker
void	resetStats()
io.netty.util.concurrent.Future<Void>	sendMessage(Message msg) Sends message to serialization.
String	toString()

Methods inherited from class io.netty.channel.SimpleChannelInboundHandler

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.channel.ChannelHandler

handlerRemoved

Field Detail

lastMessageSentAt

protected volatile long lastMessageSentAt

System.nanoTime value about when was sent the last message Protected to be updated also in tests.

Method Detail

getKeepAliveTimerValue

public final Integer getKeepAliveTimerValue()

getDeadTimerValue

public final Integer getDeadTimerValue()

sendMessage

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

Sends message to serialization.

Specified by:

sendMessage in interface PCEPSession

Parameters:

msg - to be sent

Returns:

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

isClosed

public boolean isClosed()

close

public void close()

Closes PCEP session without sending a Close message, as the channel is no longer active.

Specified by:

close in interface AutoCloseable

close

public void close(TerminationReason reason)

Closes PCEP session, cancels all timers, returns to state Idle, sends the Close Message. KeepAlive and DeadTimer are cancelled if the state of the session changes to IDLE. This method is used to close the PCEP session from inside the session or from the listener, therefore the parent of this session should be informed.

Specified by:

close in interface PCEPSession

getRemoteTlvs

public Tlvs getRemoteTlvs()

Specified by:

getRemoteTlvs in interface PCEPSession

getRemoteAddress

public InetAddress getRemoteAddress()

Specified by:

getRemoteAddress in interface PCEPSession

endOfInput

public void endOfInput()

handleMalformedMessage

public void handleMalformedMessage(PCEPErrors error)

The fact, that a message is malformed, comes from parser. In case of unrecognized message a particular error is sent (CAPABILITY_NOT_SUPPORTED) and the method checks if the MAX_UNKNOWN_MSG per minute wasn't overstepped. Second, any other error occurred that is specified by rfc. In this case, the an error message is generated and sent.

Parameters:

error - documented error in RFC5440 or draft

handleMessage

public void handleMessage(Message msg)

Handles incoming message. If the session is up, it notifies the user. The user is notified about every message except KeepAlive.

Parameters:

msg - incoming message

toString

public final String toString()

Overrides:

toString in class Object

getMessages

public Messages getMessages()

Description copied from interface: PcepSessionState

The statistics of PCEP received/sent messages from the PCE point of view.

Specified by:

getMessages in interface PcepSessionState

Returns:

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.stats.rev141006.pcep.session.state.Messages messages, or null if not present

getLocalPref

public LocalPref getLocalPref()

Description copied from interface: PcepSessionState

The local (PCE) preferences.

Specified by:

getLocalPref in interface PcepSessionState

Returns:

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.stats.rev141006.pcep.session.state.LocalPref localPref, or null if not present

getPeerPref

public PeerPref getPeerPref()

Description copied from interface: PcepSessionState

The remote peer (PCC) preferences.

Specified by:

getPeerPref in interface PcepSessionState

Returns:

org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.controller.pcep.stats.rev141006.pcep.session.state.PeerPref peerPref, or null if not present

getImplementedInterface

public Class<? extends org.opendaylight.yangtools.yang.binding.DataContainer> getImplementedInterface()

Specified by:

getImplementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer

resetStats

public void resetStats()

Specified by:

resetStats in interface PCEPSession

channelInactive

public final void channelInactive(io.netty.channel.ChannelHandlerContext ctx)

Specified by:

channelInactive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelInactive in class io.netty.channel.ChannelInboundHandlerAdapter

channelRead0

protected final void channelRead0(io.netty.channel.ChannelHandlerContext ctx,
                                  Message msg)

Specified by:

channelRead0 in class io.netty.channel.SimpleChannelInboundHandler<Message>

handlerAdded

public final void handlerAdded(io.netty.channel.ChannelHandlerContext ctx)

Specified by:

handlerAdded in interface io.netty.channel.ChannelHandler

Overrides:

handlerAdded in class io.netty.channel.ChannelHandlerAdapter

exceptionCaught

public void exceptionCaught(io.netty.channel.ChannelHandlerContext ctx,
                            Throwable cause)

Specified by:

exceptionCaught in interface io.netty.channel.ChannelHandler

Specified by:

exceptionCaught in interface io.netty.channel.ChannelInboundHandler

Overrides:

exceptionCaught in class io.netty.channel.ChannelInboundHandlerAdapter

localSessionCharacteristics

public Tlvs localSessionCharacteristics()

Description copied from interface: PCEPSession

Returns session characteristics of the local PCEP Speaker

Specified by:

localSessionCharacteristics in interface PCEPSession

Returns:

Open message TLVs