io.pkts.packet.sctp.impl

Class SctpDataChunkImpl

java.lang.Object

io.pkts.packet.sctp.impl.DelegatingSctpChunk

io.pkts.packet.sctp.impl.SctpDataChunkImpl

All Implemented Interfaces:

SctpChunk, SctpDataChunk

public class SctpDataChunkImpl
extends DelegatingSctpChunk
implements SctpDataChunk

Nested Class Summary

Nested classes/interfaces inherited from interface io.pkts.packet.sctp.SctpChunk

SctpChunk.Type

Method Summary

Modifier and Type	Method and Description
Buffer	getHeader() Get the raw header of this SCTP Chunk
long	getPayloadProtocolIdentifier() This value represents an application (or upper layer) specified protocol identifier.
int	getStreamIdentifier() Identifies the stream to which the following user data belongs.
int	getStreamSequenceNumber() This value represents the Stream Sequence Number of the following user data within the stream S.
long	getTransmissionSequenceNumber() This value represents the TSN for this DATA chunk.
Buffer	getUserData() The actual payload of the data chunk.
boolean	isBeginningFragment() Flag: B bit
boolean	isEndingFragment() Flag: E bit
boolean	isImmediate() Flag: I bit
boolean	isUnordered() Flag: U bit
static SctpDataChunk	of(DefaultSctpChunk chunk)

Methods inherited from class io.pkts.packet.sctp.impl.DelegatingSctpChunk

getFlags, getLength, getPadding, getType, getValue, getValueLength

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.pkts.packet.sctp.SctpDataChunk

getType

Methods inherited from interface io.pkts.packet.sctp.SctpChunk

frame, getFlags, getLength, getPadding, getValue, getValueLength, lookup

Method Detail

of

public static final SctpDataChunk of(DefaultSctpChunk chunk)

getHeader

public Buffer getHeader()

Description copied from interface: SctpChunk

Get the raw header of this SCTP Chunk

Specified by:

getHeader in interface SctpChunk

Overrides:

getHeader in class DelegatingSctpChunk

isUnordered

public boolean isUnordered()

Description copied from interface: SctpDataChunk

Flag: U bit

The (U)nordered bit, if set to '1', indicates that this is an unordered DATA chunk, and there is no Stream Sequence Number assigned to this DATA chunk. Therefore, the receiver MUST ignore the Stream Sequence Number field.

After reassembly (if necessary), unordered DATA chunks MUST be dispatched to the upper layer by the receiver without any attempt to reorder.

If an unordered user message is fragmented, each fragment of the message MUST have its U bit set to '1'.

(source: RFC 4960 Section 3.3.1)

Specified by:

isUnordered in interface SctpDataChunk

Returns:

isBeginningFragment

public boolean isBeginningFragment()

Description copied from interface: SctpDataChunk

Flag: B bit

(source: RFC 4960 Section 3.3.1)

Specified by:

isBeginningFragment in interface SctpDataChunk

Returns:

isEndingFragment

public boolean isEndingFragment()

Description copied from interface: SctpDataChunk

Flag: E bit

The (E)nding fragment bit, if set, indicates the last fragment of a user message.

An unfragmented user message shall have both the B and E bits set to '1'. Setting both B and E bits to '0' indicates a middle fragment of a multi-fragment user message, as summarized in the following table:

     B E                  Description
 ============================================================
 |  1 0 | First piece of a fragmented user message          |
 +----------------------------------------------------------+
 |  0 0 | Middle piece of a fragmented user message         |
 +----------------------------------------------------------+
 |  0 1 | Last piece of a fragmented user message           |
 +----------------------------------------------------------+
 |  1 1 | Unfragmented message                              |
 ============================================================
 |             Table 1: Fragment Description Flags          |
 ============================================================
 

When a user message is fragmented into multiple chunks, the TSNs are used by the receiver to reassemble the message. This means that the TSNs for each fragment of a fragmented user message MUST be strictly sequential. (source: RFC 4960 Section 3.3.1)

Specified by:

isEndingFragment in interface SctpDataChunk

Returns:

isImmediate

public boolean isImmediate()

Description copied from interface: SctpDataChunk

Flag: I bit

By setting this bit, the sender of a DATA chunk indicates that the corresponding SACK chunk should not be delayed.

(source: RFC 7053 Section 3)

Specified by:

isImmediate in interface SctpDataChunk

getTransmissionSequenceNumber

public long getTransmissionSequenceNumber()

Description copied from interface: SctpDataChunk

This value represents the TSN for this DATA chunk. The valid range of TSN is from 0 to 4294967295 (2**32 - 1). TSN wraps back to 0 after reaching 4294967295.

(source: RFC 4960 Section 3.3.1)

Specified by:

getTransmissionSequenceNumber in interface SctpDataChunk

getStreamIdentifier

public int getStreamIdentifier()

Description copied from interface: SctpDataChunk

Identifies the stream to which the following user data belongs.

(source: RFC 4960 Section 3.3.1)

Specified by:

getStreamIdentifier in interface SctpDataChunk

getStreamSequenceNumber

public int getStreamSequenceNumber()

Description copied from interface: SctpDataChunk

This value represents the Stream Sequence Number of the following user data within the stream S. Valid range is 0 to 65535.

When a user message is fragmented by SCTP for transport, the same Stream Sequence Number MUST be carried in each of the fragments of the message.

(source: RFC 4960 Section 3.3.1)

Specified by:

getStreamSequenceNumber in interface SctpDataChunk

getPayloadProtocolIdentifier

public long getPayloadProtocolIdentifier()

Description copied from interface: SctpDataChunk

This value represents an application (or upper layer) specified protocol identifier. This value is passed to SCTP by its upper layer and sent to its peer. This identifier is not used by SCTP but can be used by certain network entities, as well as by the peer application, to identify the type of information being carried in this DATA chunk. This field must be sent even in fragmented DATA chunks (to make sure it is available for agents in the middle of the network). Note that this field is NOT touched by an SCTP implementation; therefore, its byte order is NOT necessarily big endian. The upper layer is responsible for any byte order conversions to this field.

The value 0 indicates that no application identifier is specified by the upper layer for this payload data.

(source: RFC 4960 Section 3.3.1)

Specified by:

getPayloadProtocolIdentifier in interface SctpDataChunk

getUserData

public Buffer getUserData()

Description copied from interface: SctpDataChunk

The actual payload of the data chunk. The returned buffer will not contain any potential padding.

Specified by:

getUserData in interface SctpDataChunk