Class SctpPacket

java.lang.Object

org.pcap4j.packet.AbstractPacket

org.pcap4j.packet.SctpPacket

All Implemented Interfaces:

Serializable, Iterable<Packet>, Packet, TransportPacket

public final class SctpPacket
extends AbstractPacket
implements TransportPacket

SCTP Packet

Since:

pcap4j 1.6.6

See Also:

• RFC 4960
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SctpPacket.Builder
static interface	SctpPacket.SctpChunk	The interface representing an SCTP Chunk Field.
static final class	SctpPacket.SctpHeader	SCTP header

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 SctpPacket.SctpHeader	header
private static final org.slf4j.Logger	logger
private final Packet	payload
private static final long	serialVersionUID

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SctpPacket.Builder	getBuilder()	Returns a new Builder object populated with this object's fields' values.
SctpPacket.SctpHeader	getHeader()	Returns the Header object representing this packet's header.
Packet	getPayload()	Returns the Packet object representing this packet's payload.
boolean	hasValidChecksum()
static SctpPacket	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

logger

private static final org.slf4j.Logger logger

header

private final SctpPacket.SctpHeader header

payload

private final Packet payload

Constructor Details

SctpPacket

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

Throws:

IllegalRawDataException

SctpPacket

private SctpPacket(SctpPacket.Builder builder)

Method Details

newPacket

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

Throws:

IllegalRawDataException - if parsing the raw data fails.

getHeader

public SctpPacket.SctpHeader 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

getBuilder

public SctpPacket.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

hasValidChecksum

public boolean hasValidChecksum()

Returns:

true if the checksum in this header is valid; false otherwise.