Module org.pcap4j.core

Package org.pcap4j.packet

Class TcpPacket.Builder

java.lang.Object

org.pcap4j.packet.AbstractPacket.AbstractBuilder

org.pcap4j.packet.TcpPacket.Builder

All Implemented Interfaces:

java.lang.Iterable<Packet.Builder>, ChecksumBuilder<TcpPacket>, LengthBuilder<TcpPacket>, Packet.Builder

Enclosing class:

TcpPacket

public static final class TcpPacket.Builder
extends AbstractPacket.AbstractBuilder
implements LengthBuilder<TcpPacket>, ChecksumBuilder<TcpPacket>

Since:

pcap4j 0.9.12

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	ack
private int	acknowledgmentNumber
private short	checksum
private boolean	correctChecksumAtBuild
private boolean	correctLengthAtBuild
private byte	dataOffset
private java.net.InetAddress	dstAddr
private TcpPort	dstPort
private boolean	fin
private java.util.List<TcpPacket.TcpOption>	options
private byte[]	padding
private boolean	paddingAtBuild
private Packet.Builder	payloadBuilder
private boolean	psh
private byte	reserved
private boolean	rst
private int	sequenceNumber
private java.net.InetAddress	srcAddr
private TcpPort	srcPort
private boolean	syn
private boolean	urg
private short	urgentPointer
private short	window

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(TcpPacket packet)

Method Summary

Modifier and Type	Method	Description
TcpPacket.Builder	ack(boolean ack)
TcpPacket.Builder	acknowledgmentNumber(int acknowledgmentNumber)
TcpPacket	build()	Build a packet object using values set to this object.
TcpPacket.Builder	checksum(short checksum)
TcpPacket.Builder	correctChecksumAtBuild(boolean correctChecksumAtBuild)
TcpPacket.Builder	correctLengthAtBuild(boolean correctLengthAtBuild)
TcpPacket.Builder	dataOffset(byte dataOffset)
TcpPacket.Builder	dstAddr(java.net.InetAddress dstAddr)	used for checksum calculation If the lower-layer packet is a IPv6 packet and the extension headers including a routing header, this parameter is that of the final destination.
TcpPacket.Builder	dstPort(TcpPort dstPort)
TcpPacket.Builder	fin(boolean fin)
Packet.Builder	getPayloadBuilder()	Get the payload builder of this object.
TcpPacket.Builder	options(java.util.List<TcpPacket.TcpOption> options)
TcpPacket.Builder	padding(byte[] padding)
TcpPacket.Builder	paddingAtBuild(boolean paddingAtBuild)
TcpPacket.Builder	payloadBuilder(Packet.Builder payloadBuilder)	Set the payload builder.
TcpPacket.Builder	psh(boolean psh)
TcpPacket.Builder	reserved(byte reserved)
TcpPacket.Builder	rst(boolean rst)
TcpPacket.Builder	sequenceNumber(int sequenceNumber)
TcpPacket.Builder	srcAddr(java.net.InetAddress srcAddr)	used for checksum calculation.
TcpPacket.Builder	srcPort(TcpPort srcPort)
TcpPacket.Builder	syn(boolean syn)
TcpPacket.Builder	urg(boolean urg)
TcpPacket.Builder	urgentPointer(short urgentPointer)
TcpPacket.Builder	window(short window)

Methods inherited from class org.pcap4j.packet.AbstractPacket.AbstractBuilder

get, getOuterOf, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

srcPort

private TcpPort srcPort

dstPort

private TcpPort dstPort

sequenceNumber

private int sequenceNumber

acknowledgmentNumber

private int acknowledgmentNumber

dataOffset

private byte dataOffset

reserved

private byte reserved

urg

private boolean urg

ack

private boolean ack

psh

private boolean psh

rst

private boolean rst

syn

private boolean syn

fin

private boolean fin

window

private short window

checksum

private short checksum

urgentPointer

private short urgentPointer

options

private java.util.List<TcpPacket.TcpOption> options

padding

private byte[] padding

payloadBuilder

private Packet.Builder payloadBuilder

srcAddr

private java.net.InetAddress srcAddr

dstAddr

private java.net.InetAddress dstAddr

correctLengthAtBuild

private boolean correctLengthAtBuild

correctChecksumAtBuild

private boolean correctChecksumAtBuild

paddingAtBuild

private boolean paddingAtBuild

Constructor Detail

Builder

public Builder()

Builder

public Builder(TcpPacket packet)

Parameters:

packet - packet

Method Detail

srcPort

public TcpPacket.Builder srcPort(TcpPort srcPort)

Parameters:

srcPort - srcPort

Returns:

this Builder object for method chaining.

dstPort

public TcpPacket.Builder dstPort(TcpPort dstPort)

Parameters:

dstPort - dstPort

Returns:

this Builder object for method chaining.

sequenceNumber

public TcpPacket.Builder sequenceNumber(int sequenceNumber)

Parameters:

sequenceNumber - sequenceNumber

Returns:

this Builder object for method chaining.

acknowledgmentNumber

public TcpPacket.Builder acknowledgmentNumber(int acknowledgmentNumber)

Parameters:

acknowledgmentNumber - acknowledgmentNumber

Returns:

this Builder object for method chaining.

dataOffset

public TcpPacket.Builder dataOffset(byte dataOffset)

Parameters:

dataOffset - dataOffset

Returns:

this Builder object for method chaining.

reserved

public TcpPacket.Builder reserved(byte reserved)

Parameters:

reserved - reserved

Returns:

this Builder object for method chaining.

urg

public TcpPacket.Builder urg(boolean urg)

Parameters:

urg - urg

Returns:

this Builder object for method chaining.

ack

public TcpPacket.Builder ack(boolean ack)

Parameters:

ack - ack

Returns:

this Builder object for method chaining.

psh

public TcpPacket.Builder psh(boolean psh)

Parameters:

psh - psh

Returns:

this Builder object for method chaining.

rst

public TcpPacket.Builder rst(boolean rst)

Parameters:

rst - rst

Returns:

this Builder object for method chaining.

syn

public TcpPacket.Builder syn(boolean syn)

Parameters:

syn - syn

Returns:

this Builder object for method chaining.

fin

public TcpPacket.Builder fin(boolean fin)

Parameters:

fin - fin

Returns:

this Builder object for method chaining.

window

public TcpPacket.Builder window(short window)

Parameters:

window - window

Returns:

this Builder object for method chaining.

checksum

public TcpPacket.Builder checksum(short checksum)

Parameters:

checksum - checksum

Returns:

this Builder object for method chaining.

urgentPointer

public TcpPacket.Builder urgentPointer(short urgentPointer)

Parameters:

urgentPointer - urgentPointer

Returns:

this Builder object for method chaining.

options

public TcpPacket.Builder options(java.util.List<TcpPacket.TcpOption> options)

Parameters:

options - options

Returns:

this Builder object for method chaining.

padding

public TcpPacket.Builder padding(byte[] padding)

Parameters:

padding - padding

Returns:

this Builder object for method chaining.

payloadBuilder

public TcpPacket.Builder payloadBuilder(Packet.Builder payloadBuilder)

Description copied from interface: Packet.Builder

Set the payload builder.

Specified by:

payloadBuilder in interface Packet.Builder

Overrides:

payloadBuilder in class AbstractPacket.AbstractBuilder

Parameters:

payloadBuilder - a Builder object to set

Returns:

this Builder object for method chaining

getPayloadBuilder

public Packet.Builder getPayloadBuilder()

Description copied from interface: Packet.Builder

Get the payload builder of this object.

Specified by:

getPayloadBuilder in interface Packet.Builder

Overrides:

getPayloadBuilder in class AbstractPacket.AbstractBuilder

Returns:

the payload builder of this object

srcAddr

public TcpPacket.Builder srcAddr(java.net.InetAddress srcAddr)

used for checksum calculation.

Parameters:

srcAddr - srcAddr

Returns:

this Builder object for method chaining.

dstAddr

public TcpPacket.Builder dstAddr(java.net.InetAddress dstAddr)

used for checksum calculation If the lower-layer packet is a IPv6 packet and the extension headers including a routing header, this parameter is that of the final destination. (i.e. the last element of the Routing header)

Parameters:

dstAddr - dstAddr

Returns:

this Builder object for method chaining.

correctLengthAtBuild

public TcpPacket.Builder correctLengthAtBuild(boolean correctLengthAtBuild)

Specified by:

correctLengthAtBuild in interface LengthBuilder<TcpPacket>

Parameters:

correctLengthAtBuild - correctLengthAtBuild

Returns:

LengthBuilder

correctChecksumAtBuild

public TcpPacket.Builder correctChecksumAtBuild(boolean correctChecksumAtBuild)

Specified by:

correctChecksumAtBuild in interface ChecksumBuilder<TcpPacket>

Parameters:

correctChecksumAtBuild - correctChecksumAtBuild

Returns:

ChecksumBuilder

paddingAtBuild

public TcpPacket.Builder paddingAtBuild(boolean paddingAtBuild)

Parameters:

paddingAtBuild - paddingAtBuild

Returns:

this Builder object for method chaining.

build

public TcpPacket build()

Description copied from interface: Packet.Builder

Build a packet object using values set to this object.

Specified by:

build in interface ChecksumBuilder<TcpPacket>

Specified by:

build in interface LengthBuilder<TcpPacket>

Specified by:

build in interface Packet.Builder

Specified by:

build in class AbstractPacket.AbstractBuilder

Returns:

a new Packet object