org.onlab.packet

Interface IPacket

All Known Implementing Classes:

ARP, Authentication, BaseOptions, BasePacket, Data, DestinationOptions, DHCP, DHCP6, Dhcp6ClientIdOption, Dhcp6Duid, Dhcp6IaAddressOption, Dhcp6IaNaOption, Dhcp6IaTaOption, Dhcp6Option, Dhcp6RelayOption, DhcpOption, DhcpRelayAgentOption, EAP, EAPOL, EncapSecurityPayload, Ethernet, Fragment, HopByHopOptions, ICMP, ICMP6, IGMP, IGMP.IGMPv2, IGMP.IGMPv3, IP, IPv4, IPv6, LLC, LLDP, MPLS, NeighborAdvertisement, NeighborDiscoveryOptions, NeighborSolicitation, ONOSLLDP, PIM, PIMHello, PIMJoinPrune, RADIUS, Redirect, RouterAdvertisement, RouterSolicitation, Routing, TCP, UDP, VXLAN

public interface IPacket

Packet Interface.

Method Summary

Modifier and Type	Method and Description
Object	clone() Clone this packet and its payload packet but not its parent.
IPacket	deserialize(byte[] data, int offset, int length) Deprecated. in Cardinal Release
IPacket	getParent() Obtain the parent packet.
IPacket	getPayload() Obtain the packet payload.
void	resetChecksum() Reset any checksum as needed, and call resetChecksum on all parents.
byte[]	serialize() Sets all payloads parent packet if applicable, then serializes this packet and all payloads.
IPacket	setParent(IPacket packet) Configure a new parent packet.
IPacket	setPayload(IPacket packet) Assign the packet payload.

Method Detail

getPayload

IPacket getPayload()

Obtain the packet payload.

Returns:

the payload

setPayload

IPacket setPayload(IPacket packet)

Assign the packet payload.

Parameters:

packet - new payload

Returns:

self

getParent

IPacket getParent()

Obtain the parent packet.

Returns:

parent packet

setParent

IPacket setParent(IPacket packet)

Configure a new parent packet.

Parameters:

packet - new parent

Returns:

self

resetChecksum

void resetChecksum()

Reset any checksum as needed, and call resetChecksum on all parents.

serialize

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

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

Deprecated. in Cardinal Release

Deserialize this packet layer and all possible payloads. NOTE: This method has been deprecated and will be removed in a future release. It is now recommended to use the Deserializer function provided by the deserialize() method on each packet to deserialize them. The Deserializer functions are robust to malformed input.

Parameters:

data - bytes to deserialize

offset - offset to start deserializing from

length - length of the data to deserialize

Returns:

the deserialized data

clone

Object clone()

Clone this packet and its payload packet but not its parent.

Returns:

the clone