Module org.pcap4j.core

Package org.pcap4j.packet

Class UdpPacket

java.lang.Object

org.pcap4j.packet.AbstractPacket

org.pcap4j.packet.UdpPacket

All Implemented Interfaces:

Serializable, Iterable<Packet>, Packet, TransportPacket

public final class UdpPacket
extends AbstractPacket
implements TransportPacket

Since:

pcap4j 0.9.1

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UdpPacket.Builder
static final class	UdpPacket.UdpHeader

Nested classes/interfaces inherited from class org.pcap4j.packet.AbstractPacket

AbstractPacket.AbstractBuilder, AbstractPacket.AbstractHeader

Nested classes/interfaces inherited from interface org.pcap4j.packet.Packet

Packet.Header

Nested classes/interfaces inherited from interface org.pcap4j.packet.TransportPacket

TransportPacket.TransportHeader

Field Summary

Fields

Modifier and Type	Field	Description
private final UdpPacket.UdpHeader	header
private final Packet	payload
private static final long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	UdpPacket(byte[] rawData, int offset, int length)
private	UdpPacket(UdpPacket.Builder builder)

Method Summary

Modifier and Type	Method	Description
UdpPacket.Builder	getBuilder()	Returns a new Builder object populated with this object's fields' values.
UdpPacket.UdpHeader	getHeader()	Returns the Header object representing this packet's header.
Packet	getPayload()	Returns the Packet object representing this packet's payload.
boolean	hasValidChecksum(InetAddress srcAddr, InetAddress dstAddr, boolean acceptZero)	checksum verification is necessary for IPv6(i.e.
static UdpPacket	newPacket(byte[] rawData, int offset, int length)	A static factory method.

Methods inherited from class org.pcap4j.packet.AbstractPacket

buildHexString, buildRawData, buildString, calcHashCode, calcLength, contains, equals, get, getOuterOf, getRawData, hashCode, iterator, length, toHexString, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.pcap4j.packet.Packet

contains, get, getOuterOf, getRawData, length

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

header

private final UdpPacket.UdpHeader header

payload

private final Packet payload

Constructor Details

UdpPacket

private UdpPacket(byte[] rawData,
 int offset,
 int length)
           throws IllegalRawDataException

Throws:

IllegalRawDataException

UdpPacket

private UdpPacket(UdpPacket.Builder builder)

Method Details

newPacket

public static UdpPacket newPacket(byte[] rawData,
 int offset,
 int length)
                           throws IllegalRawDataException

A static factory method. This method validates the arguments by ByteArrays.validateBounds(byte[], int, int), which may throw exceptions undocumented here.

Parameters:

rawData - rawData

offset - offset

length - length

Returns:

a new UdpPacket object.

Throws:

IllegalRawDataException - if parsing the raw data fails.

getHeader

public UdpPacket.UdpHeader getHeader()

Description copied from class: AbstractPacket

Returns the Header object representing this packet's header. This subclass have to override this method if the packet represented by the subclass has a header.

Specified by:

getHeader in interface Packet

Specified by:

getHeader in interface TransportPacket

Overrides:

getHeader in class AbstractPacket

Returns:

the Header object representing this packet's header. May be null if the header doesn't exist

getPayload

public Packet getPayload()

Description copied from class: AbstractPacket

Returns the Packet object representing this packet's payload. This subclass have to override this method if the packet represented by the subclass has a payload.

Specified by:

getPayload in interface Packet

Overrides:

getPayload in class AbstractPacket

Returns:

the Packet object representing this packet's payload. May be null if the payload doesn't exist

hasValidChecksum

public boolean hasValidChecksum(InetAddress srcAddr,
 InetAddress dstAddr,
 boolean acceptZero)

checksum verification is necessary for IPv6(i.e. acceptZero must be false)

Parameters:

srcAddr - srcAddr

dstAddr - dstAddr

acceptZero - acceptZero

Returns:

true if the packet represented by this object has a valid checksum; false otherwise.

getBuilder

public UdpPacket.Builder getBuilder()

Description copied from interface: Packet

Returns a new Builder object populated with this object's fields' values.

Specified by:

getBuilder in interface Packet

Specified by:

getBuilder in class AbstractPacket

Returns:

a new Builder object populated with this object's fields values