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

Class PerMessageDeflateClientExtensionHandshaker

java.lang.Object

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

All Implemented Interfaces:

WebSocketClientExtensionHandshaker

public final class PerMessageDeflateClientExtensionHandshaker
extends Object
implements WebSocketClientExtensionHandshaker

permessage-deflate handshake implementation.

Constructor Summary

Constructors

Constructor and Description
PerMessageDeflateClientExtensionHandshaker() Deprecated. Use PerMessageDeflateClientExtensionHandshaker(int).
PerMessageDeflateClientExtensionHandshaker(int maxAllocation) Constructor with default configuration.
PerMessageDeflateClientExtensionHandshaker(int compressionLevel, boolean allowClientWindowSize, int requestedServerWindowSize, boolean allowClientNoContext, boolean requestedServerNoContext) Deprecated. Use PerMessageDeflateClientExtensionHandshaker( int, boolean, int, boolean, boolean, int).
PerMessageDeflateClientExtensionHandshaker(int compressionLevel, boolean allowClientWindowSize, int requestedServerWindowSize, boolean allowClientNoContext, boolean requestedServerNoContext, int maxAllocation) Constructor with custom configuration.
PerMessageDeflateClientExtensionHandshaker(int compressionLevel, boolean allowClientWindowSize, int requestedServerWindowSize, boolean allowClientNoContext, boolean requestedServerNoContext, WebSocketExtensionFilterProvider extensionFilterProvider) Deprecated. Use PerMessageDeflateClientExtensionHandshaker( int, boolean, int, boolean, boolean, WebSocketExtensionFilterProvider, int).
PerMessageDeflateClientExtensionHandshaker(int compressionLevel, boolean allowClientWindowSize, int requestedServerWindowSize, boolean allowClientNoContext, boolean requestedServerNoContext, WebSocketExtensionFilterProvider extensionFilterProvider, int maxAllocation) Constructor with custom configuration.

Method Summary

Modifier and Type	Method and Description
WebSocketClientExtension	handshakeExtension(WebSocketExtensionData extensionData) Handshake based on server response.
WebSocketExtensionData	newRequestData() Return extension configuration to submit to the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerMessageDeflateClientExtensionHandshaker

@Deprecated
public PerMessageDeflateClientExtensionHandshaker()

Deprecated. Use PerMessageDeflateClientExtensionHandshaker(int).

Constructor with default configuration.

PerMessageDeflateClientExtensionHandshaker

public PerMessageDeflateClientExtensionHandshaker(int maxAllocation)

Constructor with default configuration.

Parameters:

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

PerMessageDeflateClientExtensionHandshaker

@Deprecated
public PerMessageDeflateClientExtensionHandshaker(int compressionLevel,
                                                              boolean allowClientWindowSize,
                                                              int requestedServerWindowSize,
                                                              boolean allowClientNoContext,
                                                              boolean requestedServerNoContext)

Deprecated. Use PerMessageDeflateClientExtensionHandshaker( int, boolean, int, boolean, boolean, int).

Constructor with custom configuration.

Parameters:

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

allowClientWindowSize - allows WebSocket server to customize the client inflater window size (default is false).

requestedServerWindowSize - indicates the requested sever window size to use if server inflater is customizable.

allowClientNoContext - allows WebSocket server to activate client_no_context_takeover (default is false).

requestedServerNoContext - indicates if client needs to activate server_no_context_takeover if server is compatible with (default is false).

PerMessageDeflateClientExtensionHandshaker

public PerMessageDeflateClientExtensionHandshaker(int compressionLevel,
                                                  boolean allowClientWindowSize,
                                                  int requestedServerWindowSize,
                                                  boolean allowClientNoContext,
                                                  boolean requestedServerNoContext,
                                                  int maxAllocation)

Constructor with custom configuration.

Parameters:

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

allowClientWindowSize - allows WebSocket server to customize the client inflater window size (default is false).

requestedServerWindowSize - indicates the requested sever window size to use if server inflater is customizable.

allowClientNoContext - allows WebSocket server to activate client_no_context_takeover (default is false).

requestedServerNoContext - indicates if client needs to activate server_no_context_takeover if server is compatible with (default is false).

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

PerMessageDeflateClientExtensionHandshaker

@Deprecated
public PerMessageDeflateClientExtensionHandshaker(int compressionLevel,
                                                              boolean allowClientWindowSize,
                                                              int requestedServerWindowSize,
                                                              boolean allowClientNoContext,
                                                              boolean requestedServerNoContext,
                                                              WebSocketExtensionFilterProvider extensionFilterProvider)

Deprecated. Use PerMessageDeflateClientExtensionHandshaker( int, boolean, int, boolean, boolean, WebSocketExtensionFilterProvider, int).

Constructor with custom configuration.

Parameters:

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

allowClientWindowSize - allows WebSocket server to customize the client inflater window size (default is false).

requestedServerWindowSize - indicates the requested sever window size to use if server inflater is customizable.

allowClientNoContext - allows WebSocket server to activate client_no_context_takeover (default is false).

requestedServerNoContext - indicates if client needs to activate server_no_context_takeover if server is compatible with (default is false).

extensionFilterProvider - provides client extension filters for per message deflate encoder and decoder.

PerMessageDeflateClientExtensionHandshaker

public PerMessageDeflateClientExtensionHandshaker(int compressionLevel,
                                                  boolean allowClientWindowSize,
                                                  int requestedServerWindowSize,
                                                  boolean allowClientNoContext,
                                                  boolean requestedServerNoContext,
                                                  WebSocketExtensionFilterProvider extensionFilterProvider,
                                                  int maxAllocation)

Constructor with custom configuration.

Parameters:

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

allowClientWindowSize - allows WebSocket server to customize the client inflater window size (default is false).

requestedServerWindowSize - indicates the requested sever window size to use if server inflater is customizable.

allowClientNoContext - allows WebSocket server to activate client_no_context_takeover (default is false).

requestedServerNoContext - indicates if client needs to activate server_no_context_takeover if server is compatible with (default is false).

extensionFilterProvider - provides client extension filters for per message deflate encoder and decoder.

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

Method Detail

newRequestData

public WebSocketExtensionData newRequestData()

Description copied from interface: WebSocketClientExtensionHandshaker

Return extension configuration to submit to the server.

Specified by:

newRequestData in interface WebSocketClientExtensionHandshaker

Returns:

the desired extension configuration.

handshakeExtension

public WebSocketClientExtension handshakeExtension(WebSocketExtensionData extensionData)

Description copied from interface: WebSocketClientExtensionHandshaker

Handshake based on server response. It should always succeed because server response should be a request acknowledge.

Specified by:

handshakeExtension in interface WebSocketClientExtensionHandshaker

Parameters:

extensionData - the extension configuration sent by the server.

Returns:

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