Class UdpPacket.UdpHeader

java.lang.Object

org.pcap4j.packet.AbstractPacket.AbstractHeader

org.pcap4j.packet.UdpPacket.UdpHeader

All Implemented Interfaces:

Serializable, Packet.Header, TransportPacket.TransportHeader

Enclosing class:

UdpPacket

public static final class UdpPacket.UdpHeader
extends AbstractPacket.AbstractHeader
implements TransportPacket.TransportHeader

Since:

pcap4j 0.9.1

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final short	checksum
private static final int	CHECKSUM_OFFSET
private static final int	CHECKSUM_SIZE
private static final int	DST_PORT_OFFSET
private static final int	DST_PORT_SIZE
private final UdpPort	dstPort
private static final int	IPV4_PSEUDO_HEADER_SIZE
private static final int	IPV6_PSEUDO_HEADER_SIZE
private final short	length
private static final int	LENGTH_OFFSET
private static final int	LENGTH_SIZE
private static final long	serialVersionUID
private static final int	SRC_PORT_OFFSET
private static final int	SRC_PORT_SIZE
private final UdpPort	srcPort
private static final int	UCP_HEADER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
private byte[]	buildRawData(boolean zeroInsteadOfChecksum)
protected String	buildString()	This method builds the value toString() will return.
private short	calcChecksum(InetAddress srcAddr, InetAddress dstAddr, byte[] header, byte[] payload)
protected int	calcHashCode()	This method builds the value hashCode() will return using the byte array getRawData() returns.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one using return values of getRawData().
short	getChecksum()
UdpPort	getDstPort()
short	getLength()
int	getLengthAsInt()
protected List<byte[]>	getRawFields()	Returns a list of byte arrays which represents this header's fields.
private List<byte[]>	getRawFields(boolean zeroInsteadOfChecksum)
UdpPort	getSrcPort()
int	length()	Returns the header length in bytes.

Methods inherited from class AbstractPacket.AbstractHeader

buildHexString, buildRawData, calcLength, getRawData, hashCode, toHexString, toString

Methods inherited from class Object

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

Methods inherited from interface Packet.Header

getRawData

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

SRC_PORT_OFFSET

private static final int SRC_PORT_OFFSET

See Also:

• Constant Field Values

SRC_PORT_SIZE

private static final int SRC_PORT_SIZE

See Also:

• Constant Field Values

DST_PORT_OFFSET

private static final int DST_PORT_OFFSET

See Also:

• Constant Field Values

DST_PORT_SIZE

private static final int DST_PORT_SIZE

See Also:

• Constant Field Values

LENGTH_OFFSET

private static final int LENGTH_OFFSET

See Also:

• Constant Field Values

LENGTH_SIZE

private static final int LENGTH_SIZE

See Also:

• Constant Field Values

CHECKSUM_OFFSET

private static final int CHECKSUM_OFFSET

See Also:

• Constant Field Values

CHECKSUM_SIZE

private static final int CHECKSUM_SIZE

See Also:

• Constant Field Values

UCP_HEADER_SIZE

private static final int UCP_HEADER_SIZE

See Also:

• Constant Field Values

IPV4_PSEUDO_HEADER_SIZE

private static final int IPV4_PSEUDO_HEADER_SIZE

See Also:

• Constant Field Values

IPV6_PSEUDO_HEADER_SIZE

private static final int IPV6_PSEUDO_HEADER_SIZE

See Also:

• Constant Field Values

srcPort

private final UdpPort srcPort

dstPort

private final UdpPort dstPort

length

private final short length

checksum

private final short checksum

Constructor Details

UdpHeader

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

Throws:

IllegalRawDataException

UdpHeader

private UdpHeader(UdpPacket.Builder builder,
 byte[] payload)

Method Details

calcChecksum

private short calcChecksum(InetAddress srcAddr,
 InetAddress dstAddr,
 byte[] header,
 byte[] payload)

getSrcPort

public UdpPort getSrcPort()

Specified by:

getSrcPort in interface TransportPacket.TransportHeader

Returns:

Source port

getDstPort

public UdpPort getDstPort()

Specified by:

getDstPort in interface TransportPacket.TransportHeader

Returns:

Destination port

getLength

public short getLength()

Returns:

length

getLengthAsInt

public int getLengthAsInt()

Returns:

length

getChecksum

public short getChecksum()

Returns:

checksum

getRawFields

protected List<byte[]> getRawFields()

Description copied from class: AbstractPacket.AbstractHeader

Returns a list of byte arrays which represents this header's fields. This method is called by calcLength() and buildRawData().

Specified by:

getRawFields in class AbstractPacket.AbstractHeader

Returns:

a list of byte arrays which represents this header's fields

getRawFields

private List<byte[]> getRawFields(boolean zeroInsteadOfChecksum)

buildRawData

private byte[] buildRawData(boolean zeroInsteadOfChecksum)

length

public int length()

Description copied from class: AbstractPacket.AbstractHeader

Returns the header length in bytes. This method calls calcLength() and caches the return value when it is called for the first time, and then, this method returns the cached value from the second time.

Specified by:

length in interface Packet.Header

Overrides:

length in class AbstractPacket.AbstractHeader

Returns:

the length of the byte stream of the header represented by this object in bytes

buildString

protected String buildString()

Description copied from class: AbstractPacket.AbstractHeader

This method builds the value toString() will return.

Overrides:

buildString in class AbstractPacket.AbstractHeader

Returns:

a string representation of this object

equals

public boolean equals(Object obj)

Description copied from class: AbstractPacket.AbstractHeader

Indicates whether some other object is "equal to" this one using return values of getRawData(). This method should be overridden so that it does more strict comparisons more efficiently.

Overrides:

equals in class AbstractPacket.AbstractHeader

calcHashCode

protected int calcHashCode()

Description copied from class: AbstractPacket.AbstractHeader

This method builds the value hashCode() will return using the byte array getRawData() returns. This method may be better to be overridden for performance reason.

Overrides:

calcHashCode in class AbstractPacket.AbstractHeader

Returns:

a calculated hash code value for the object