Home / Class/ SctpMessage Class — netty Architecture

SctpMessage Class — netty Architecture

Architecture documentation for the SctpMessage class in SctpMessage.java from the netty codebase.

Entity Profile

Dependency Diagram

graph TD
  14ff1a62_eeaa_597c_bd7e_86e9076839e3["SctpMessage"]
  1ed8bbf9_d42e_cc87_cf3b_d3cb61f22aa1["SctpMessage.java"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|defined in| 1ed8bbf9_d42e_cc87_cf3b_d3cb61f22aa1
  cf8fdf6c_566c_7f90_1b06_58757eee0ec5["SctpMessage()"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|method| cf8fdf6c_566c_7f90_1b06_58757eee0ec5
  ccd01f85_dd22_4a93_1fc7_af672c13b907["streamIdentifier()"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|method| ccd01f85_dd22_4a93_1fc7_af672c13b907
  1ecaa019_c0dd_9c8c_5a9d_9ace61e1f4d1["protocolIdentifier()"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|method| 1ecaa019_c0dd_9c8c_5a9d_9ace61e1f4d1
  60df3bf4_d012_46e3_7f71_7736adf861a3["isUnordered()"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|method| 60df3bf4_d012_46e3_7f71_7736adf861a3
  507b8278_2cba_1eaf_4ec6_338eea2fa005["MessageInfo()"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|method| 507b8278_2cba_1eaf_4ec6_338eea2fa005
  85492d1f_0b61_708c_7b1b_b98a47c8666a["isComplete()"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|method| 85492d1f_0b61_708c_7b1b_b98a47c8666a
  728895eb_3115_d61b_7a20_88c9622eb9df["equals()"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|method| 728895eb_3115_d61b_7a20_88c9622eb9df
  f7cd49ca_df64_f622_b1c5_01419dfa3dc5["hashCode()"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|method| f7cd49ca_df64_f622_b1c5_01419dfa3dc5
  b16aaebc_a967_f9fe_44f6_a45e29e6c4ee["String()"]
  14ff1a62_eeaa_597c_bd7e_86e9076839e3 -->|method| b16aaebc_a967_f9fe_44f6_a45e29e6c4ee

Relationship Graph

Source Code

transport-sctp/src/main/java/io/netty/channel/sctp/SctpMessage.java lines 26–204

public final class SctpMessage extends DefaultByteBufHolder {
    private final int streamIdentifier;
    private final int protocolIdentifier;
    private final boolean unordered;

    private final MessageInfo msgInfo;

    /**
     * Essential data that is being carried within SCTP Data Chunk
     * @param protocolIdentifier of payload
     * @param streamIdentifier that you want to send the payload
     * @param payloadBuffer channel buffer
     */
    public SctpMessage(int protocolIdentifier, int streamIdentifier, ByteBuf payloadBuffer) {
        this(protocolIdentifier, streamIdentifier, false, payloadBuffer);
    }

    /**
     * Essential data that is being carried within SCTP Data Chunk
     * @param protocolIdentifier of payload
     * @param streamIdentifier that you want to send the payload
     * @param unordered if {@literal true}, the SCTP Data Chunk will be sent with the U (unordered) flag set.
     * @param payloadBuffer channel buffer
     */
    public SctpMessage(int protocolIdentifier, int streamIdentifier, boolean unordered, ByteBuf payloadBuffer) {
        super(payloadBuffer);
        this.protocolIdentifier = protocolIdentifier;
        this.streamIdentifier = streamIdentifier;
        this.unordered = unordered;
        msgInfo = null;
    }

    /**
     * Essential data that is being carried within SCTP Data Chunk
     * @param msgInfo       the {@link MessageInfo}
     * @param payloadBuffer channel buffer
     */
    public SctpMessage(MessageInfo msgInfo, ByteBuf payloadBuffer) {
        super(payloadBuffer);
        this.msgInfo = ObjectUtil.checkNotNull(msgInfo, "msgInfo");
        this.streamIdentifier = msgInfo.streamNumber();
        this.protocolIdentifier = msgInfo.payloadProtocolID();
        this.unordered = msgInfo.isUnordered();
    }

    /**
     * Return the stream-identifier
     */
    public int streamIdentifier() {
        return streamIdentifier;
    }

    /**
     * Return the protocol-identifier
     */
    public int protocolIdentifier() {
        return protocolIdentifier;
    }

    /**
     * return the unordered flag
     */
    public boolean isUnordered() {
        return unordered;
    }

    /**
     * Return the {@link MessageInfo} for inbound messages or {@code null} for
     * outbound messages.
     */
    public MessageInfo messageInfo() {
        return msgInfo;
    }

    /**
     * Return {@code true} if this message is complete.
     */
    public boolean isComplete() {
        if (msgInfo != null) {
            return msgInfo.isComplete();
        }  else {

Frequently Asked Questions

What is the SctpMessage class?
SctpMessage is a class in the netty codebase, defined in transport-sctp/src/main/java/io/netty/channel/sctp/SctpMessage.java.
Where is SctpMessage defined?
SctpMessage is defined in transport-sctp/src/main/java/io/netty/channel/sctp/SctpMessage.java at line 26.

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free