org.onosproject.pcepio.protocol

Interface PcepCloseMsg

All Superinterfaces:

PcepMessage, PcepObject, Writeable

public interface PcepCloseMsg
extends PcepObject, PcepMessage

Abstraction of an entity providing PCEP Close Message.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PcepCloseMsg.Builder Builder interface with get and set functions to build Close message.

Method Summary

Modifier and Type	Method and Description
LinkedList<PcepValueType>	getOptionalTlv() Returns LinkedList of Optional Tlv in Close Message.
byte	getReason() Returns reason field in Close message.
PcepType	getType() Returns Type of PCEP Message.
PcepVersion	getVersion() Returns Version of PCEP Object.
void	setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) Sets LinkedList of Optional Tlvs in Close Message.
void	setReason(byte value) Sets reason field in Close message with specified value.
void	writeTo(org.jboss.netty.buffer.ChannelBuffer channelBuffer) Writes byte streams of messages to channel buffer.

Method Detail

getVersion

PcepVersion getVersion()

Description copied from interface: PcepObject

Returns Version of PCEP Object.

Specified by:

getVersion in interface PcepMessage

Specified by:

getVersion in interface PcepObject

Returns:

Version of PCEP Object

getType

PcepType getType()

Description copied from interface: PcepMessage

Returns Type of PCEP Message.

Specified by:

getType in interface PcepMessage

Returns:

Type of PCEP Message

getReason

byte getReason()

Returns reason field in Close message.

Returns:

reason field

setReason

void setReason(byte value)

Sets reason field in Close message with specified value.

Parameters:

value - of Reason field

getOptionalTlv

LinkedList<PcepValueType> getOptionalTlv()

Returns LinkedList of Optional Tlv in Close Message.

Returns:

list of optional tlv

setOptionalTlv

void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv)

Sets LinkedList of Optional Tlvs in Close Message.

Parameters:

llOptionalTlv - LinkedList of type PcepValueType

writeTo

void writeTo(org.jboss.netty.buffer.ChannelBuffer channelBuffer)
      throws PcepParseException

Description copied from interface: Writeable

Writes byte streams of messages to channel buffer.

Specified by:

writeTo in interface PcepMessage

Specified by:

writeTo in interface Writeable

Parameters:

channelBuffer - parameter of type channel buffer

Throws:

PcepParseException - when error occurs while writing pcep message to channel buffer