Package 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 java.lang.Object
implements WebSocketServerExtensionHandshaker

perframe-deflate handshake implementation.

Constructor Summary

Constructors

Constructor	Description
DeflateFrameServerExtensionHandshaker()	Constructor with default configuration.
DeflateFrameServerExtensionHandshaker(int compressionLevel)	Constructor with custom configuration.
DeflateFrameServerExtensionHandshaker(int compressionLevel, WebSocketExtensionFilterProvider extensionFilterProvider)	Constructor with custom configuration.

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

Constructor Detail

DeflateFrameServerExtensionHandshaker

public DeflateFrameServerExtensionHandshaker()

Constructor with default configuration.

DeflateFrameServerExtensionHandshaker

public DeflateFrameServerExtensionHandshaker(int compressionLevel)

Constructor with custom configuration.

Parameters:

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

DeflateFrameServerExtensionHandshaker

public DeflateFrameServerExtensionHandshaker(int compressionLevel,
                                             WebSocketExtensionFilterProvider extensionFilterProvider)

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.

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.