Class DeflateFrameServerExtensionHandshaker

java.lang.Object

io.netty.handler.codec.http.websocketx.extensions.compression.DeflateFrameServerExtensionHandshaker

All Implemented Interfaces:

WebSocketServerExtensionHandshaker

public final class DeflateFrameServerExtensionHandshaker
extends java.lang.Object
implements WebSocketServerExtensionHandshaker

perframe-deflate handshake implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	DeflateFrameServerExtensionHandshaker.DeflateFrameServerExtension

Field Summary

Fields

Modifier and Type	Field	Description
private final int	compressionLevel
static final int	DEFAULT_COMPRESSION_LEVEL
static final int	DEFAULT_MEM_LEVEL
(package private) static final java.lang.String	DEFLATE_FRAME_EXTENSION
private final WebSocketExtensionFilterProvider	extensionFilterProvider
static final int	MAX_MEM_LEVEL
static final int	MAX_WINDOW_SIZE
private final int	maxAllocation
private final int	memLevel
static final int	MIN_MEM_LEVEL
static final int	MIN_WINDOW_SIZE
private final int	windowSize
(package private) static final java.lang.String	X_WEBKIT_DEFLATE_FRAME_EXTENSION

Constructor Summary

Constructors

Constructor	Description
DeflateFrameServerExtensionHandshaker()	Deprecated. Use DeflateFrameServerExtensionHandshaker(int, int) with DEFAULT_COMPRESSION_LEVEL.
DeflateFrameServerExtensionHandshaker(int compressionLevel)	Deprecated. Use DeflateFrameServerExtensionHandshaker(int, int).
DeflateFrameServerExtensionHandshaker(int compressionLevel, int maxAllocation)	Constructor with custom configuration.
DeflateFrameServerExtensionHandshaker(int compressionLevel, int windowSize, int memLevel, int maxAllocation)	Constructor with custom configuration including compressor memory limits.
DeflateFrameServerExtensionHandshaker(int compressionLevel, int windowSize, int memLevel, WebSocketExtensionFilterProvider extensionFilterProvider, int maxAllocation)	Constructor with full custom configuration.
DeflateFrameServerExtensionHandshaker(int compressionLevel, WebSocketExtensionFilterProvider extensionFilterProvider)	Deprecated. Use DeflateFrameServerExtensionHandshaker(int, WebSocketExtensionFilterProvider, int).
DeflateFrameServerExtensionHandshaker(int compressionLevel, WebSocketExtensionFilterProvider extensionFilterProvider, int maxAllocation)	Deprecated. Use DeflateFrameServerExtensionHandshaker(int, int, int, WebSocketExtensionFilterProvider, int).

Method Summary

Modifier and Type	Method	Description
WebSocketServerExtension	handshakeExtension(WebSocketExtensionData extensionData)	Handshake based on client request.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_COMPRESSION_LEVEL

public static final int DEFAULT_COMPRESSION_LEVEL

See Also:

• Constant Field Values

MIN_WINDOW_SIZE

public static final int MIN_WINDOW_SIZE

See Also:

• Constant Field Values

MAX_WINDOW_SIZE

public static final int MAX_WINDOW_SIZE

See Also:

• Constant Field Values

DEFAULT_MEM_LEVEL

public static final int DEFAULT_MEM_LEVEL

See Also:

• Constant Field Values

MIN_MEM_LEVEL

public static final int MIN_MEM_LEVEL

See Also:

• Constant Field Values

MAX_MEM_LEVEL

public static final int MAX_MEM_LEVEL

See Also:

• Constant Field Values

X_WEBKIT_DEFLATE_FRAME_EXTENSION

static final java.lang.String X_WEBKIT_DEFLATE_FRAME_EXTENSION

See Also:

• Constant Field Values

DEFLATE_FRAME_EXTENSION

static final java.lang.String DEFLATE_FRAME_EXTENSION

See Also:

• Constant Field Values

compressionLevel

private final int compressionLevel

windowSize

private final int windowSize

memLevel

private final int memLevel

extensionFilterProvider

private final WebSocketExtensionFilterProvider extensionFilterProvider

maxAllocation

private final int maxAllocation

Constructor Details

DeflateFrameServerExtensionHandshaker

@Deprecated
public DeflateFrameServerExtensionHandshaker()

Deprecated.

Use DeflateFrameServerExtensionHandshaker(int, int) with DEFAULT_COMPRESSION_LEVEL.

Constructor with default configuration.

DeflateFrameServerExtensionHandshaker

@Deprecated
public DeflateFrameServerExtensionHandshaker(int compressionLevel)

Deprecated.

Use DeflateFrameServerExtensionHandshaker(int, int).

Constructor with custom configuration.

Parameters:

compressionLevel - Compression level between 0 and 9 (default is 6).

DeflateFrameServerExtensionHandshaker

public DeflateFrameServerExtensionHandshaker(int compressionLevel,
 int maxAllocation)

Constructor with custom configuration.

Parameters:

compressionLevel - Compression level between 0 and 9 (default is 6).

maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.

DeflateFrameServerExtensionHandshaker

public DeflateFrameServerExtensionHandshaker(int compressionLevel,
 int windowSize,
 int memLevel,
 int maxAllocation)

Constructor with custom configuration including compressor memory limits.

Parameters:

compressionLevel - Compression level between 0 and 9 (default is 6).

windowSize - zlib window size in bits (8-15) for the server-side deflater. Lower values reduce per-connection memory at the cost of compression ratio.

memLevel - zlib memory level for the server-side deflater (1-9). Lower values reduce per-connection memory at the cost of compression ratio.

maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.

DeflateFrameServerExtensionHandshaker

@Deprecated
public DeflateFrameServerExtensionHandshaker(int compressionLevel,
 WebSocketExtensionFilterProvider extensionFilterProvider)

Deprecated.

Use DeflateFrameServerExtensionHandshaker(int, WebSocketExtensionFilterProvider, int).

Constructor with custom configuration.

Parameters:

compressionLevel - Compression level between 0 and 9 (default is 6).

extensionFilterProvider - provides server extension filters for per frame deflate encoder and decoder.

DeflateFrameServerExtensionHandshaker

@Deprecated
public DeflateFrameServerExtensionHandshaker(int compressionLevel,
 WebSocketExtensionFilterProvider extensionFilterProvider,
 int maxAllocation)

Deprecated.

Use DeflateFrameServerExtensionHandshaker(int, int, int, WebSocketExtensionFilterProvider, int).

Constructor with custom configuration.

Parameters:

compressionLevel - Compression level between 0 and 9 (default is 6).

extensionFilterProvider - provides server extension filters for per frame deflate encoder and decoder.

maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.

DeflateFrameServerExtensionHandshaker

public DeflateFrameServerExtensionHandshaker(int compressionLevel,
 int windowSize,
 int memLevel,
 WebSocketExtensionFilterProvider extensionFilterProvider,
 int maxAllocation)

Constructor with full custom configuration.

Parameters:

compressionLevel - Compression level between 0 and 9 (default is 6).

windowSize - zlib window size in bits (8-15) for the server-side deflater.

memLevel - zlib memory level for the server-side deflater (1-9).

extensionFilterProvider - provides server extension filters for per frame deflate encoder and decoder.

maxAllocation - Maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.

Method Details

handshakeExtension

public WebSocketServerExtension handshakeExtension(WebSocketExtensionData extensionData)

Description copied from interface: WebSocketServerExtensionHandshaker

Handshake based on client request. It must failed with null if server cannot handle it.

Specified by:

handshakeExtension in interface WebSocketServerExtensionHandshaker

Parameters:

extensionData - the extension configuration sent by the client.

Returns:

an initialized extension if handshake phase succeed or null if failed.