org.onosproject.pcepio.protocol

Interface PcepOpenMsg

All Superinterfaces:

PcepMessage, PcepObject, Writeable

All Known Implementing Classes:

PcepOpenMsgVer1

public interface PcepOpenMsg
extends PcepObject, PcepMessage

Abstraction of an entity providing PCEP Open Message.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
PcepOpenObject	getPcepOpenObject() Returns OpenObject in Open Message.
PcepType	getType() Returns Type of PCEP Message.
PcepVersion	getVersion() Returns Version of PCEP Object.
void	setPcepOpenObject(PcepOpenObject obj) Sets OpenObject in Open Message with Specified Obj.
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

setPcepOpenObject

void setPcepOpenObject(PcepOpenObject obj)

Sets OpenObject in Open Message with Specified Obj.

Parameters:

obj - OpenObject

getPcepOpenObject

PcepOpenObject getPcepOpenObject()

Returns OpenObject in Open Message.

Returns:

OpenObject in Open Message

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