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

类 PerMessageDeflateClientExtensionHandshaker

java.lang.Object

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

所有已实现的接口:

WebSocketClientExtensionHandshaker

public final class PerMessageDeflateClientExtensionHandshaker
extends java.lang.Object
implements WebSocketClientExtensionHandshaker

permessage-deflate handshake implementation.

构造器概要

构造器

构造器和说明
PerMessageDeflateClientExtensionHandshaker() Constructor with default configuration.
PerMessageDeflateClientExtensionHandshaker(int compressionLevel, boolean allowClientWindowSize, int requestedServerWindowSize, boolean allowClientNoContext, boolean requestedServerNoContext) Constructor with custom configuration.
PerMessageDeflateClientExtensionHandshaker(int compressionLevel, boolean allowClientWindowSize, int requestedServerWindowSize, boolean allowClientNoContext, boolean requestedServerNoContext, WebSocketExtensionFilterProvider extensionFilterProvider) Constructor with custom configuration.

方法概要

限定符和类型	方法和说明
WebSocketClientExtension	handshakeExtension(WebSocketExtensionData extensionData) Handshake based on server response.
WebSocketExtensionData	newRequestData() Return extension configuration to submit to the server.

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

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

构造器详细资料

PerMessageDeflateClientExtensionHandshaker

public PerMessageDeflateClientExtensionHandshaker()

Constructor with default configuration.

PerMessageDeflateClientExtensionHandshaker

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

Constructor with custom configuration.

参数:

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,
                                                  WebSocketExtensionFilterProvider extensionFilterProvider)

Constructor with custom configuration.

参数:

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.

方法详细资料

newRequestData

public WebSocketExtensionData newRequestData()

从接口复制的说明: WebSocketClientExtensionHandshaker

Return extension configuration to submit to the server.

指定者:

newRequestData 在接口中 WebSocketClientExtensionHandshaker

返回:

the desired extension configuration.

handshakeExtension

public WebSocketClientExtension handshakeExtension(WebSocketExtensionData extensionData)

从接口复制的说明: WebSocketClientExtensionHandshaker

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

指定者:

handshakeExtension 在接口中 WebSocketClientExtensionHandshaker

参数:

extensionData - the extension configuration sent by the server.

返回:

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