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

类 PerMessageDeflateServerExtensionHandshaker

java.lang.Object

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

所有已实现的接口:

WebSocketServerExtensionHandshaker

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

permessage-deflate handshake implementation.

字段概要

字段

限定符和类型	字段和说明
static int	MAX_WINDOW_SIZE
static int	MIN_WINDOW_SIZE

构造器概要

构造器

构造器和说明
PerMessageDeflateServerExtensionHandshaker() Constructor with default configuration.
PerMessageDeflateServerExtensionHandshaker(int compressionLevel, boolean allowServerWindowSize, int preferredClientWindowSize, boolean allowServerNoContext, boolean preferredClientNoContext) Constructor with custom configuration.
PerMessageDeflateServerExtensionHandshaker(int compressionLevel, boolean allowServerWindowSize, int preferredClientWindowSize, boolean allowServerNoContext, boolean preferredClientNoContext, WebSocketExtensionFilterProvider extensionFilterProvider) Constructor with custom configuration.

方法概要

限定符和类型	方法和说明
WebSocketServerExtension	handshakeExtension(WebSocketExtensionData extensionData) Handshake based on client request.

从类继承的方法 java.lang.Object

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

字段详细资料

MIN_WINDOW_SIZE

public static final int MIN_WINDOW_SIZE

另请参阅:

常量字段值

MAX_WINDOW_SIZE

public static final int MAX_WINDOW_SIZE

另请参阅:

常量字段值

构造器详细资料

PerMessageDeflateServerExtensionHandshaker

public PerMessageDeflateServerExtensionHandshaker()

Constructor with default configuration.

PerMessageDeflateServerExtensionHandshaker

public PerMessageDeflateServerExtensionHandshaker(int compressionLevel,
                                                  boolean allowServerWindowSize,
                                                  int preferredClientWindowSize,
                                                  boolean allowServerNoContext,
                                                  boolean preferredClientNoContext)

Constructor with custom configuration.

参数:

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

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

preferredClientWindowSize - indicates the preferred client window size to use if client inflater is customizable.

allowServerNoContext - allows WebSocket client to activate server_no_context_takeover (default is false).

preferredClientNoContext - indicates if server prefers to activate client_no_context_takeover if client is compatible with (default is false).

PerMessageDeflateServerExtensionHandshaker

public PerMessageDeflateServerExtensionHandshaker(int compressionLevel,
                                                  boolean allowServerWindowSize,
                                                  int preferredClientWindowSize,
                                                  boolean allowServerNoContext,
                                                  boolean preferredClientNoContext,
                                                  WebSocketExtensionFilterProvider extensionFilterProvider)

Constructor with custom configuration.

参数:

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

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

preferredClientWindowSize - indicates the preferred client window size to use if client inflater is customizable.

allowServerNoContext - allows WebSocket client to activate server_no_context_takeover (default is false).

preferredClientNoContext - indicates if server prefers to activate client_no_context_takeover if client is compatible with (default is false).

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

方法详细资料

handshakeExtension

public WebSocketServerExtension handshakeExtension(WebSocketExtensionData extensionData)

从接口复制的说明: WebSocketServerExtensionHandshaker

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

指定者:

handshakeExtension 在接口中 WebSocketServerExtensionHandshaker

参数:

extensionData - the extension configuration sent by the client.

返回:

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