Home / Type/ SctpChannelConfig Type — netty Architecture

SctpChannelConfig Type — netty Architecture

Architecture documentation for the SctpChannelConfig type/interface in SctpChannelConfig.java from the netty codebase.

Entity Profile

Dependency Diagram

graph TD
  e8dc8fa8_76f4_e023_0ad7_aa9bf639946b["SctpChannelConfig"]
  d06e4843_74fe_5fd2_e60e_a97243ef57c2["SctpChannelConfig.java"]
  e8dc8fa8_76f4_e023_0ad7_aa9bf639946b -->|defined in| d06e4843_74fe_5fd2_e60e_a97243ef57c2
  style e8dc8fa8_76f4_e023_0ad7_aa9bf639946b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

transport-sctp/src/main/java/io/netty/channel/sctp/SctpChannelConfig.java lines 48–135

public interface SctpChannelConfig extends ChannelConfig {

    /**
     * Gets the <a href="https://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
     * {@code SCTP_NODELAY}</a> option.  Please note that the default value of this option is {@code true} unlike the
     * operating system default ({@code false}). However, for some buggy platforms, such as Android, that shows erratic
     * behavior with Nagle's algorithm disabled, the default value remains to be {@code false}.
     */
    boolean isSctpNoDelay();

    /**
     * Sets the <a href="https://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
     * {@code SCTP_NODELAY}</a> option.  Please note that the default value of this option is {@code true} unlike the
     * operating system default ({@code false}). However, for some buggy platforms, such as Android, that shows erratic
     * behavior with Nagle's algorithm disabled, the default value remains to be {@code false}.
     */
    SctpChannelConfig setSctpNoDelay(boolean sctpNoDelay);

    /**
     * Gets the <a href="https://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
     *     {@code SO_SNDBUF}</a> option.
     */
    int getSendBufferSize();

    /**
     * Sets the <a href="https://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
     *     {@code SO_SNDBUF}</a> option.
     */
    SctpChannelConfig setSendBufferSize(int sendBufferSize);

    /**
     * Gets the <a href="https://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
     *     {@code SO_RCVBUF}</a> option.
     */
    int getReceiveBufferSize();

    /**
     * Gets the <a href="https://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
     *     {@code SO_RCVBUF}</a> option.
     */
    SctpChannelConfig setReceiveBufferSize(int receiveBufferSize);

    /**
     * Gets the <a href="https://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
     *     {@code SCTP_INIT_MAXSTREAMS}</a> option.
     */
    InitMaxStreams getInitMaxStreams();

    /**
     * Gets the <a href="https://openjdk.java.net/projects/sctp/javadoc/com/sun/nio/sctp/SctpStandardSocketOption.html">
     *     {@code SCTP_INIT_MAXSTREAMS}</a> option.
     */
    SctpChannelConfig setInitMaxStreams(InitMaxStreams initMaxStreams);

    @Override
    SctpChannelConfig setConnectTimeoutMillis(int connectTimeoutMillis);

    @Override
    @Deprecated
    SctpChannelConfig setMaxMessagesPerRead(int maxMessagesPerRead);

    @Override
    SctpChannelConfig setWriteSpinCount(int writeSpinCount);

    @Override
    SctpChannelConfig setAllocator(ByteBufAllocator allocator);

    @Override
    SctpChannelConfig setRecvByteBufAllocator(RecvByteBufAllocator allocator);

    @Override
    SctpChannelConfig setAutoRead(boolean autoRead);

    @Override
    SctpChannelConfig setAutoClose(boolean autoClose);

    @Override
    SctpChannelConfig setWriteBufferHighWaterMark(int writeBufferHighWaterMark);

    @Override
    SctpChannelConfig setWriteBufferLowWaterMark(int writeBufferLowWaterMark);

Frequently Asked Questions

What is the SctpChannelConfig type?
SctpChannelConfig is a type/interface in the netty codebase, defined in transport-sctp/src/main/java/io/netty/channel/sctp/SctpChannelConfig.java.
Where is SctpChannelConfig defined?
SctpChannelConfig is defined in transport-sctp/src/main/java/io/netty/channel/sctp/SctpChannelConfig.java at line 48.

Analyze Your Own Codebase

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

Try Supermodel Free