org.onlab.packet.pim

Class PIMHello

java.lang.Object

org.onlab.packet.BasePacket

org.onlab.packet.pim.PIMHello

All Implemented Interfaces:

IPacket

public class PIMHello
extends BasePacket

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PIMHello.Option PIM Option types.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MINIMUM_OPTION_LEN_BYTES

Fields inherited from class org.onlab.packet.BasePacket

parent, payload

Constructor Summary

Constructors

Constructor and Description
PIMHello()

Method Summary

Modifier and Type	Method and Description
void	addGenId() Add the genid.
void	addGenId(int genid) Add a Gen ID.
void	addHoldtime(int holdtime) Add the holdtime to the packet.
void	addPriority(int priority) Add the hello priority.
IPacket	deserialize(byte[] data, int offset, int length) XXX: This is deprecated, DO NOT USE, use the deserializer() function instead.
static Deserializer<PIMHello>	deserializer() Deserialize this hello message.
byte[]	serialize() Sets all payloads parent packet if applicable, then serializes this packet and all payloads.

Methods inherited from class org.onlab.packet.BasePacket

clone, equals, getParent, getPayload, hashCode, resetChecksum, setParent, setPayload

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

MINIMUM_OPTION_LEN_BYTES

public static final int MINIMUM_OPTION_LEN_BYTES

See Also:

Constant Field Values

Constructor Detail

PIMHello

public PIMHello()

Method Detail

addHoldtime

public void addHoldtime(int holdtime)

Add the holdtime to the packet.

Parameters:

holdtime - the holdtime in seconds

addPriority

public void addPriority(int priority)

Add the hello priority.

Parameters:

priority - default is 1, the higher the better

addGenId

public void addGenId(int genid)

Add a Gen ID.

Parameters:

genid - a random generated number, changes only after reset.

addGenId

public void addGenId()

Add the genid. Let this function figure out the number.

serialize

public byte[] serialize()

Sets all payloads parent packet if applicable, then serializes this packet and all payloads.

Returns:

a byte[] containing this packet and payloads

deserialize

public IPacket deserialize(byte[] data,
                           int offset,
                           int length)

XXX: This is deprecated, DO NOT USE, use the deserializer() function instead.

Parameters:

data - bytes to deserialize

offset - offset to start deserializing from

length - length of the data to deserialize

Returns:

the deserialized data

deserializer

public static Deserializer<PIMHello> deserializer()

Deserialize this hello message.

Returns:

a deserialized hello message.