Class TcpPacket

java.lang.Object

org.pcap4j.packet.AbstractPacket

org.pcap4j.packet.TcpPacket

All Implemented Interfaces:

Serializable, Iterable<Packet>, Packet, TransportPacket

public final class TcpPacket
extends AbstractPacket
implements TransportPacket

Since:

pcap4j 0.9.12

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TcpPacket.Builder
static final class	TcpPacket.TcpHeader
static interface	TcpPacket.TcpOption	The interface representing a TCP option.

Nested classes/interfaces inherited from class AbstractPacket

AbstractPacket.AbstractBuilder, AbstractPacket.AbstractHeader

Nested classes/interfaces inherited from interface Packet

Packet.Header

Nested classes/interfaces inherited from interface TransportPacket

TransportPacket.TransportHeader

Field Summary

Fields

Modifier and Type	Field	Description
private final TcpPacket.TcpHeader	header
private final Packet	payload
private static final long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
TcpPacket.Builder	getBuilder()	Returns a new Builder object populated with this object's fields' values.
TcpPacket.TcpHeader	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 TcpPacket	newPacket(byte[] rawData, int offset, int length)	A static factory method.

Methods inherited from class AbstractPacket

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

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, iterator, spliterator

Methods inherited from interface Packet

contains, get, getOuterOf, getRawData, length

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

header

private final TcpPacket.TcpHeader header

payload

private final Packet payload

Constructor Details

TcpPacket

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

Throws:

IllegalRawDataException

TcpPacket

private TcpPacket(TcpPacket.Builder builder)

Method Details

newPacket

public static TcpPacket 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 TcpPacket object.

Throws:

IllegalRawDataException - if parsing the raw data fails.

getHeader

public TcpPacket.TcpHeader 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 TcpPacket.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