Home / Class/ WebSocketServerProtocolConfig Class — netty Architecture

WebSocketServerProtocolConfig Class — netty Architecture

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

Entity Profile

Dependency Diagram

graph TD
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3["WebSocketServerProtocolConfig"]
  e8767c74_dfe5_a28c_4fa2_4918427c8176["WebSocketServerProtocolConfig.java"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|defined in| e8767c74_dfe5_a28c_4fa2_4918427c8176
  b0c6d5b9_0843_c191_7d7c_d8568b8d3cb1["WebSocketServerProtocolConfig()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| b0c6d5b9_0843_c191_7d7c_d8568b8d3cb1
  4dce473e_707e_fbe1_4aad_76e1052260d7["String()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| 4dce473e_707e_fbe1_4aad_76e1052260d7
  88d57848_3ef9_0fee_ab1d_4cc7243f6467["checkStartsWith()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| 88d57848_3ef9_0fee_ab1d_4cc7243f6467
  88376514_5205_db25_4ecd_ebca453d50ad["handshakeTimeoutMillis()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| 88376514_5205_db25_4ecd_ebca453d50ad
  7ad781d5_395e_e653_01a6_b0763e9f68db["forceCloseTimeoutMillis()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| 7ad781d5_395e_e653_01a6_b0763e9f68db
  761a2377_9fba_cf49_9f0c_0c995f6ca837["handleCloseFrames()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| 761a2377_9fba_cf49_9f0c_0c995f6ca837
  1b90b95a_cb23_adcd_83c9_382f32753fb3["WebSocketCloseStatus()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| 1b90b95a_cb23_adcd_83c9_382f32753fb3
  fa1caf5b_1ff8_09ad_c3f3_345ad1d968e8["dropPongFrames()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| fa1caf5b_1ff8_09ad_c3f3_345ad1d968e8
  093a67df_7230_ef0b_bc07_1453dca21e1b["WebSocketDecoderConfig()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| 093a67df_7230_ef0b_bc07_1453dca21e1b
  2f5cc632_f90d_e454_83c7_a91931a84c8a["Builder()"]
  21241e4d_e2b9_561f_0f37_e5fc8d666cb3 -->|method| 2f5cc632_f90d_e454_83c7_a91931a84c8a

Relationship Graph

Source Code

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerProtocolConfig.java lines 26–296

public final class WebSocketServerProtocolConfig {

    static final long DEFAULT_HANDSHAKE_TIMEOUT_MILLIS = 10000L;

    private final String websocketPath;
    private final String subprotocols;
    private final boolean checkStartsWith;
    private final long handshakeTimeoutMillis;
    private final long forceCloseTimeoutMillis;
    private final boolean handleCloseFrames;
    private final WebSocketCloseStatus sendCloseFrame;
    private final boolean dropPongFrames;
    private final WebSocketDecoderConfig decoderConfig;

    private WebSocketServerProtocolConfig(
        String websocketPath,
        String subprotocols,
        boolean checkStartsWith,
        long handshakeTimeoutMillis,
        long forceCloseTimeoutMillis,
        boolean handleCloseFrames,
        WebSocketCloseStatus sendCloseFrame,
        boolean dropPongFrames,
        WebSocketDecoderConfig decoderConfig
    ) {
        this.websocketPath = websocketPath;
        this.subprotocols = subprotocols;
        this.checkStartsWith = checkStartsWith;
        this.handshakeTimeoutMillis = checkPositive(handshakeTimeoutMillis, "handshakeTimeoutMillis");
        this.forceCloseTimeoutMillis = forceCloseTimeoutMillis;
        this.handleCloseFrames = handleCloseFrames;
        this.sendCloseFrame = sendCloseFrame;
        this.dropPongFrames = dropPongFrames;
        this.decoderConfig = decoderConfig == null ? WebSocketDecoderConfig.DEFAULT : decoderConfig;
    }

    public String websocketPath() {
        return websocketPath;
    }

    public String subprotocols() {
        return subprotocols;
    }

    public boolean checkStartsWith() {
        return checkStartsWith;
    }

    public long handshakeTimeoutMillis() {
        return handshakeTimeoutMillis;
    }

    public long forceCloseTimeoutMillis() {
        return forceCloseTimeoutMillis;
    }

    public boolean handleCloseFrames() {
        return handleCloseFrames;
    }

    public WebSocketCloseStatus sendCloseFrame() {
        return sendCloseFrame;
    }

    public boolean dropPongFrames() {
        return dropPongFrames;
    }

    public WebSocketDecoderConfig decoderConfig() {
        return decoderConfig;
    }

    @Override
    public String toString() {
        return "WebSocketServerProtocolConfig" +
            " {websocketPath=" + websocketPath +
            ", subprotocols=" + subprotocols +
            ", checkStartsWith=" + checkStartsWith +
            ", handshakeTimeoutMillis=" + handshakeTimeoutMillis +
            ", forceCloseTimeoutMillis=" + forceCloseTimeoutMillis +
            ", handleCloseFrames=" + handleCloseFrames +

Frequently Asked Questions

What is the WebSocketServerProtocolConfig class?
WebSocketServerProtocolConfig is a class in the netty codebase, defined in codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerProtocolConfig.java.
Where is WebSocketServerProtocolConfig defined?
WebSocketServerProtocolConfig is defined in codec-http/src/main/java/io/netty/handler/codec/http/websocketx/WebSocketServerProtocolConfig.java at line 26.

Analyze Your Own Codebase

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

Try Supermodel Free