org.opendaylight.controller.liblldp

Class LLDP

java.lang.Object

org.opendaylight.controller.liblldp.Packet

org.opendaylight.controller.liblldp.LLDP

public class LLDP
extends Packet

Class that represents the LLDP frame objects

Field Summary

Fields

Modifier and Type	Field and Description
static byte[]	LLDPMulticastMac

Fields inherited from class org.opendaylight.controller.liblldp.Packet

corrupted, hdrFieldCoordMap, hdrFieldsMap, LOG, parent, payload, payloadClass, rawPayload, writeAccess

Constructor Summary

Constructors

Constructor and Description
LLDP() Default constructor that creates the tlvList LinkedHashMap
LLDP(boolean writeAccess) Constructor that creates the tlvList LinkedHashMap and sets the write access for the same

Method Summary

Modifier and Type	Method and Description
LLDP	addCustomTLV(LLDPTLV customTLV)
Packet	deserialize(byte[] data, int bitOffset, int size) This method deserializes the data bits obtained from the wire into the respective header and payload which are of type Packet
LLDPTLV	getChassisId()
LLDPTLV	getCustomTLV(CustomTLVKey key)
Iterable<LLDPTLV>	getCustomTlvList()
Iterable<LLDPTLV>	getOptionalTLVList()
LLDPTLV	getPortId()
LLDPTLV	getSystemNameId()
LLDPTLV	getTLV(String type)
LLDPTLV	getTtl()
byte[]	serialize() This method serializes the header and payload from the respective packet class, into a single stream of bytes to be sent on the wire
LLDP	setChassisId(LLDPTLV chassisId)
LLDP	setOptionalTLVList(List<LLDPTLV> optionalTLVList)
LLDP	setPortId(LLDPTLV portId)
LLDP	setSystemNameId(LLDPTLV systemNameId)
void	setTLV(String type, LLDPTLV tlv)
LLDP	setTtl(LLDPTLV ttl)

Methods inherited from class org.opendaylight.controller.liblldp.Packet

equals, getfieldnumBits, getfieldOffset, getHeaderSize, getParent, getPayload, getRawPayload, hashCode, isCorrupted, postDeserializeCustomOperation, postSerializeCustomOperation, setHeaderField, setParent, setPayload, setRawPayload, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

LLDPMulticastMac

public static final byte[] LLDPMulticastMac

Constructor Detail

LLDP

public LLDP()

Default constructor that creates the tlvList LinkedHashMap

LLDP

public LLDP(boolean writeAccess)

Constructor that creates the tlvList LinkedHashMap and sets the write access for the same

Method Detail

getTLV

public LLDPTLV getTLV(String type)

Parameters:

type - - description of the type of TLV

Returns:

LLDPTLV - full TLV

getCustomTLV

public LLDPTLV getCustomTLV(CustomTLVKey key)

setTLV

public void setTLV(String type,
                   LLDPTLV tlv)

Parameters:

type - - description of the type of TLV

tlv - - tlv to set

getChassisId

public LLDPTLV getChassisId()

Returns:

the chassisId TLV

setChassisId

public LLDP setChassisId(LLDPTLV chassisId)

Parameters:

chassisId - - the chassisId to set

getSystemNameId

public LLDPTLV getSystemNameId()

Returns:

the SystemName TLV

setSystemNameId

public LLDP setSystemNameId(LLDPTLV systemNameId)

Parameters:

systemNameId - - the systemNameId to set

getPortId

public LLDPTLV getPortId()

Returns:

LLDPTLV - the portId TLV

setPortId

public LLDP setPortId(LLDPTLV portId)

Parameters:

portId - - the portId to set

Returns:

LLDP

getTtl

public LLDPTLV getTtl()

Returns:

LLDPTLV - the ttl TLV

setTtl

public LLDP setTtl(LLDPTLV ttl)

Parameters:

ttl - - the ttl to set

Returns:

LLDP

getOptionalTLVList

public Iterable<LLDPTLV> getOptionalTLVList()

Returns:

the optionalTLVList

getCustomTlvList

public Iterable<LLDPTLV> getCustomTlvList()

Returns:

the customTlvList

setOptionalTLVList

public LLDP setOptionalTLVList(List<LLDPTLV> optionalTLVList)

Parameters:

optionalTLVList - the optionalTLVList to set

Returns:

LLDP

addCustomTLV

public LLDP addCustomTLV(LLDPTLV customTLV)

Parameters:

customTLV - the list of custom TLVs to set

Returns:

this LLDP

deserialize

public Packet deserialize(byte[] data,
                          int bitOffset,
                          int size)
                   throws PacketException

Description copied from class: Packet

This method deserializes the data bits obtained from the wire into the respective header and payload which are of type Packet

Overrides:

deserialize in class Packet

Parameters:

data - - data from wire to deserialize

bitOffset - bit position where packet header starts in data array

size - size of packet in bits

Returns:

Packet

Throws:

PacketException

serialize

public byte[] serialize()
                 throws PacketException

Description copied from class: Packet

This method serializes the header and payload from the respective packet class, into a single stream of bytes to be sent on the wire

Overrides:

serialize in class Packet

Returns:

The byte array representing the serialized Packet

Throws:

PacketException