org.onosproject.pcepio.protocol

Interface PcepOpenObject

All Known Implementing Classes:

PcepOpenObjectVer1

public interface PcepOpenObject

Abstraction of an entity providing PCEP Open Object.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
byte	getDeadTime() Returns Dead Time in Open Object.
byte	getKeepAliveTime() Returns KeepAlive Time in Open Object.
PcepObjectHeader	getOpenObjHeader() Returns Open object header.
LinkedList<PcepValueType>	getOptionalTlv() Returns list of Optional Tlvs in Open Object.
byte	getSessionId() Returns SessionId in Open Object.
PcepVersion	getVersion() Returns version of Open Object.
void	setDeadTime(byte value) Sets Dead Time in Open Object with specified value.
void	setKeepAliveTime(byte value) Sets KeepAlive Time in Open Object with specified value.
void	setOpenObjHeader(PcepObjectHeader obj) Sets Open object header in Open Object.
void	setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) Sets list of Optional Tlvs in Open Object.
void	setSessionId(byte value) Sets SessionId in Open Object with specified value.
int	write(org.jboss.netty.buffer.ChannelBuffer bb) Writes the Open into channel buffer.

Method Detail

getOpenObjHeader

PcepObjectHeader getOpenObjHeader()

Returns Open object header.

Returns:

Open object header

setOpenObjHeader

void setOpenObjHeader(PcepObjectHeader obj)

Sets Open object header in Open Object.

Parameters:

obj - Open object header

getVersion

PcepVersion getVersion()

Returns version of Open Object.

Returns:

Version of Open Object

getKeepAliveTime

byte getKeepAliveTime()

Returns KeepAlive Time in Open Object.

Returns:

KeepAlive Time in Open Object

setKeepAliveTime

void setKeepAliveTime(byte value)

Sets KeepAlive Time in Open Object with specified value.

Parameters:

value - KeepAlive Time

getDeadTime

byte getDeadTime()

Returns Dead Time in Open Object.

Returns:

Dead Time in Open Object

setDeadTime

void setDeadTime(byte value)

Sets Dead Time in Open Object with specified value.

Parameters:

value - Dead Time

getSessionId

byte getSessionId()

Returns SessionId in Open Object.

Returns:

SessionId in Open Object

setSessionId

void setSessionId(byte value)

Sets SessionId in Open Object with specified value.

Parameters:

value - SessionId

getOptionalTlv

LinkedList<PcepValueType> getOptionalTlv()

Returns list of Optional Tlvs in Open Object.

Returns:

list of Optional Tlvs

setOptionalTlv

void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv)

Sets list of Optional Tlvs in Open Object.

Parameters:

llOptionalTlv - list of Optional Tlvs

write

int write(org.jboss.netty.buffer.ChannelBuffer bb)
   throws PcepParseException

Writes the Open into channel buffer.

Parameters:

bb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - while writing Open Object into Channel Buffer.