org.onosproject.pcepio.protocol

Interface PcepTEObject

All Known Implementing Classes:

PcepTEObjectVer1

public interface PcepTEObject

Abstraction of an entity providing PCEP TE Object.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
LinkedList<PcepValueType>	getOptionalTlv() Returns list of Optional Tlvs in TE Object.
byte	getProtocolId() Returns ProtocolId in TE Object.
boolean	getRFlag() Returns R flag in TE Object.
boolean	getSFlag() Returns S flag in TE Object.
int	getTEId() Returns TE ID in TE Object.
PcepObjectHeader	getTEObjHeader() Returns TE object header.
void	setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv) Sets list of Optional Tlvs in TE Object.
void	setProtocolId(byte yProtId) Sets ProtocolId in TE Object.
void	setRFlag(boolean bRFlag) Sets R flag in TE Object.
void	setSFlag(boolean bSFlag) Sets S flag in TE Object.
void	setTEId(int iTEId) Sets TE ID in TE Object.
void	setTEObjHeader(PcepObjectHeader obj) Sets TE Object header.
int	write(org.jboss.netty.buffer.ChannelBuffer bb) Writes the TE Object into channel buffer.

Method Detail

getTEObjHeader

PcepObjectHeader getTEObjHeader()

Returns TE object header.

Returns:

TE object header

setTEObjHeader

void setTEObjHeader(PcepObjectHeader obj)

Sets TE Object header.

Parameters:

obj - TE Object header

getProtocolId

byte getProtocolId()

Returns ProtocolId in TE Object.

Returns:

ProtocolId in TE Object

setProtocolId

void setProtocolId(byte yProtId)

Sets ProtocolId in TE Object.

Parameters:

yProtId - ProtocolId in TE Object

getRFlag

boolean getRFlag()

Returns R flag in TE Object.

Returns:

R flag in TE Object

setRFlag

void setRFlag(boolean bRFlag)

Sets R flag in TE Object.

Parameters:

bRFlag - R flag in TE Object

getSFlag

boolean getSFlag()

Returns S flag in TE Object.

Returns:

S flag in TE Object

setSFlag

void setSFlag(boolean bSFlag)

Sets S flag in TE Object.

Parameters:

bSFlag - S flag in TE Object

getTEId

int getTEId()

Returns TE ID in TE Object.

Returns:

TE ID in TE Object

setTEId

void setTEId(int iTEId)

Sets TE ID in TE Object.

Parameters:

iTEId - TE ID in TE Object

getOptionalTlv

LinkedList<PcepValueType> getOptionalTlv()

Returns list of Optional Tlvs in TE Object.

Returns:

list of Optional Tlvs

setOptionalTlv

void setOptionalTlv(LinkedList<PcepValueType> llOptionalTlv)

Sets list of Optional Tlvs in TE Object.

Parameters:

llOptionalTlv - list of Optional Tlvs

write

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

Writes the TE Object into channel buffer.

Parameters:

bb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - when obj header is not written to channel buffer