Module org.pcap4j.core

Package org.pcap4j.packet

Class SimplePacket

java.lang.Object

org.pcap4j.packet.AbstractPacket

org.pcap4j.packet.SimplePacket

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Packet>, Packet

Direct Known Subclasses:

CompressedPacket, EncryptedPacket, FragmentedPacket, UnknownPacket

abstract class SimplePacket
extends AbstractPacket

Since:

pcap4j 1.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimplePacket.Builder

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

Field Summary

Fields

Modifier and Type	Field	Description
private byte[]	rawData
private static long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected java.lang.String	buildString()	This method builds the value toString() will return by concatenating the header's string representation and the payload's string representation.
protected int	calcHashCode()	This method calculates the value hashCode() will return using the header's hash code and the payload's hash code.
boolean	equals(java.lang.Object obj)	Indicates whether some other object is "equal to" this one.
byte[]	getRawData()	Returns this packet's raw data.
int	length()	Returns the packet length in bytes.
protected abstract java.lang.String	modifier()

Methods inherited from class org.pcap4j.packet.AbstractPacket

buildHexString, buildRawData, calcLength, contains, get, getBuilder, getHeader, getOuterOf, getPayload, hashCode, iterator, 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, spliterator

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

rawData

private final byte[] rawData

Constructor Detail

SimplePacket

protected SimplePacket(byte[] rawData,
                       int offset,
                       int length)

SimplePacket

protected SimplePacket(SimplePacket.Builder builder)

Method Detail

length

public int length()

Description copied from class: AbstractPacket

Returns the packet 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

Overrides:

length in class AbstractPacket

Returns:

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

getRawData

public byte[] getRawData()

Description copied from class: AbstractPacket

Returns this packet's raw data. This method calls buildRawData() 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. More correctly, this method returns a copy of the cached value, so that the cache can't be changed.

Specified by:

getRawData in interface Packet

Overrides:

getRawData in class AbstractPacket

Returns:

this packet's raw data, namely the byte stream which is actually sent through real network

buildString

protected java.lang.String buildString()

Description copied from class: AbstractPacket

This method builds the value toString() will return by concatenating the header's string representation and the payload's string representation. If you write this subclass which represents a packet with extra parts (e.g. a trailer), you need to override this method.

Overrides:

buildString in class AbstractPacket

Returns:

a string representation of this object

modifier

protected abstract java.lang.String modifier()

equals

public boolean equals(java.lang.Object obj)

Description copied from class: AbstractPacket

Indicates whether some other object is "equal to" this one. This method firstly compares this packet's header using the header's equals(Object) method, then compares this packet's payload using the payload's equals(Object) method. If you write this subclass with fields which represent somethings other than header or payload, you need to override this method.

Overrides:

equals in class AbstractPacket

calcHashCode

protected int calcHashCode()

Description copied from class: AbstractPacket

This method calculates the value hashCode() will return using the header's hash code and the payload's hash code. If you write this subclass which represents a packet with extra parts (e.g. a trailer), you need to override this method.

Overrides:

calcHashCode in class AbstractPacket

Returns:

a calculated hash code value for the object