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

Class DeflateFrameServerExtensionHandshaker

java.lang.Object

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

All Implemented Interfaces:

WebSocketServerExtensionHandshaker

public final class DeflateFrameServerExtensionHandshaker
extends Object
implements WebSocketServerExtensionHandshaker

perframe-deflate handshake implementation.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COMPRESSION_LEVEL

Constructor Summary

Constructors

Constructor and 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, WebSocketExtensionFilterProvider extensionFilterProvider) Deprecated. Use DeflateFrameServerExtensionHandshaker(int, WebSocketExtensionFilterProvider, int).
DeflateFrameServerExtensionHandshaker(int compressionLevel, WebSocketExtensionFilterProvider extensionFilterProvider, int maxAllocation) Constructor with custom configuration.

Method Summary

Modifier and Type	Method and 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 Detail

DEFAULT_COMPRESSION_LEVEL

public static final int DEFAULT_COMPRESSION_LEVEL

See Also:

Constant Field Values

Constructor Detail

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

@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

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

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.

Method Detail

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.