Home / Class/ DeflateFrameClientExtensionHandshaker Class — netty Architecture

DeflateFrameClientExtensionHandshaker Class — netty Architecture

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

Entity Profile

Dependency Diagram

graph TD
  68a8c5cf_84c1_3bbd_6962_fa1f7aaa3303["DeflateFrameClientExtensionHandshaker"]
  a3669e88_3ca2_4a31_6a03_ca8d5de0b9b7["DeflateFrameClientExtensionHandshaker.java"]
  68a8c5cf_84c1_3bbd_6962_fa1f7aaa3303 -->|defined in| a3669e88_3ca2_4a31_6a03_ca8d5de0b9b7
  8493c9a4_8c7f_f43a_0cea_4f38dc62545c["DeflateFrameClientExtensionHandshaker()"]
  68a8c5cf_84c1_3bbd_6962_fa1f7aaa3303 -->|method| 8493c9a4_8c7f_f43a_0cea_4f38dc62545c
  050aed76_23c6_e7f9_db5d_3ff6cc534ad3["WebSocketExtensionData()"]
  68a8c5cf_84c1_3bbd_6962_fa1f7aaa3303 -->|method| 050aed76_23c6_e7f9_db5d_3ff6cc534ad3
  a934ba83_096f_d0bb_b8cc_d2fbed9db8aa["WebSocketClientExtension()"]
  68a8c5cf_84c1_3bbd_6962_fa1f7aaa3303 -->|method| a934ba83_096f_d0bb_b8cc_d2fbed9db8aa

Relationship Graph

Source Code

codec-http/src/main/java/io/netty/handler/codec/http/websocketx/extensions/compression/DeflateFrameClientExtensionHandshaker.java lines 34–179

public final class DeflateFrameClientExtensionHandshaker implements WebSocketClientExtensionHandshaker {

    private final int compressionLevel;
    private final boolean useWebkitExtensionName;
    private final WebSocketExtensionFilterProvider extensionFilterProvider;
    private final int maxAllocation;

    /**
     * Constructor with default configuration.
     *
     * @deprecated
     *            Use {@link DeflateFrameClientExtensionHandshaker#DeflateFrameClientExtensionHandshaker(boolean, int)}.
     */
    @Deprecated
    public DeflateFrameClientExtensionHandshaker(boolean useWebkitExtensionName) {
        this(6, useWebkitExtensionName, 0);
    }

    /**
     * Constructor with default configuration.
     *
     * @param maxAllocation
     *            Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.
     */
    public DeflateFrameClientExtensionHandshaker(boolean useWebkitExtensionName, int maxAllocation) {
        this(6, useWebkitExtensionName, maxAllocation);
    }

    /**
     * Constructor with custom configuration.
     *
     * @param compressionLevel
     *            Compression level between 0 and 9 (default is 6).
     * @deprecated
     *            Use {@link
     *            DeflateFrameClientExtensionHandshaker#DeflateFrameClientExtensionHandshaker(int, boolean, int)}.
     */
    @Deprecated
    public DeflateFrameClientExtensionHandshaker(int compressionLevel, boolean useWebkitExtensionName) {
        this(compressionLevel, useWebkitExtensionName, 0);
    }

    /**
     * Constructor with custom configuration.
     *
     * @param compressionLevel
     *            Compression level between 0 and 9 (default is 6).
     * @param maxAllocation
     *            Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.
     */
    public DeflateFrameClientExtensionHandshaker(int compressionLevel, boolean useWebkitExtensionName,
                                                 int maxAllocation) {
        this(compressionLevel, useWebkitExtensionName, WebSocketExtensionFilterProvider.DEFAULT, maxAllocation);
    }

    /**
     * Constructor with custom configuration.
     *
     * @param compressionLevel
     *            Compression level between 0 and 9 (default is 6).
     * @param extensionFilterProvider
     *            provides client extension filters for per frame deflate encoder and decoder.
     * @deprecated
     *            Use {@link DeflateFrameClientExtensionHandshaker#DeflateFrameClientExtensionHandshaker(int, boolean,
     *            WebSocketExtensionFilterProvider, int)}.
     */
    @Deprecated
    public DeflateFrameClientExtensionHandshaker(int compressionLevel, boolean useWebkitExtensionName,
                                                 WebSocketExtensionFilterProvider extensionFilterProvider) {
        this(compressionLevel, useWebkitExtensionName, extensionFilterProvider, 0);
    }

    /**
     * Constructor with custom configuration.
     *
     * @param compressionLevel
     *            Compression level between 0 and 9 (default is 6).
     * @param extensionFilterProvider
     *            provides client extension filters for per frame deflate encoder and decoder.
     * @param maxAllocation
     *            Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.

Frequently Asked Questions

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

Analyze Your Own Codebase

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

Try Supermodel Free