Top Description Inners Fields Constructors Methods
io.netty.handler.codec.http.websocketx.extensions.compression

public final Class DeflateFrameServerExtensionHandshaker

extends Object
implements WebSocketServerExtensionHandshaker
Class Inheritance
All Implemented Interfaces
io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker
Imports
io.netty.handler.codec.http.websocketx.extensions.WebSocketExtensionData, .WebSocketExtensionDecoder, .WebSocketExtensionEncoder, .WebSocketExtensionFilterProvider, .WebSocketServerExtension, .WebSocketServerExtensionHandshaker, java.util.Collections
perframe-deflate handshake implementation.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
DeflateFrameServerExtensionHandshaker.DeflateFrameServerExtension

Field Summary

Modifier and TypeField and Description
private final int
compressionLevel

pack-priv static final String
DEFLATE_FRAME_EXTENSION

private final WebSocketExtensionFilterProvider
extensionFilterProvider

pack-priv static final String
X_WEBKIT_DEFLATE_FRAME_EXTENSION

Constructor Summary

AccessConstructor and Description
public
DeflateFrameServerExtensionHandshaker()

Constructor with default configuration.

public
DeflateFrameServerExtensionHandshaker(int
Compression level between 0 and 9 (default is 6).
compressionLevel)

Constructor with custom configuration.

public
DeflateFrameServerExtensionHandshaker(int
Compression level between 0 and 9 (default is 6).
compressionLevel, WebSocketExtensionFilterProvider
provides server extension filters for per frame deflate encoder and decoder.
extensionFilterProvider)

Constructor with custom configuration.

Method Summary

Modifier and TypeMethod and Description
public WebSocketServerExtension
handshakeExtension(WebSocketExtensionData
the extension configuration sent by the client.
extensionData)

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker.handshakeExtension.

Handshake based on client request.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

compressionLevelback to summary
private final int compressionLevel
DEFLATE_FRAME_EXTENSIONback to summary
pack-priv static final String DEFLATE_FRAME_EXTENSION
extensionFilterProviderback to summary
private final WebSocketExtensionFilterProvider extensionFilterProvider
X_WEBKIT_DEFLATE_FRAME_EXTENSIONback to summary
pack-priv static final String X_WEBKIT_DEFLATE_FRAME_EXTENSION

Constructor Detail

DeflateFrameServerExtensionHandshakerback to summary
public DeflateFrameServerExtensionHandshaker()

Constructor with default configuration.

DeflateFrameServerExtensionHandshakerback to summary
public DeflateFrameServerExtensionHandshaker(int compressionLevel)

Constructor with custom configuration.

Parameters
compressionLevel:int

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

DeflateFrameServerExtensionHandshakerback to summary
public DeflateFrameServerExtensionHandshaker(int compressionLevel, WebSocketExtensionFilterProvider extensionFilterProvider)

Constructor with custom configuration.

Parameters
compressionLevel:int

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

extensionFilterProvider:WebSocketExtensionFilterProvider

provides server extension filters for per frame deflate encoder and decoder.

Method Detail

handshakeExtensionback to summary
public WebSocketServerExtension handshakeExtension(WebSocketExtensionData extensionData)

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker.handshakeExtension.

Doc from io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtensionHandshaker.handshakeExtension.

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

Parameters
extensionData:WebSocketExtensionData

the extension configuration sent by the client.

Returns:WebSocketServerExtension

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

Annotations
@Override
io.netty.handler.codec.http.websocketx.extensions.compression back to summary

private Class DeflateFrameServerExtensionHandshaker.DeflateFrameServerExtension

extends Object
implements WebSocketServerExtension
Class Inheritance
  • java.lang.Object
  • io.netty.handler.codec.http.websocketx.extensions.compression.DeflateFrameServerExtensionHandshaker.DeflateFrameServerExtension
All Implemented Interfaces
io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtension, io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension

Field Summary

Modifier and TypeField and Description
private final int
compressionLevel

private final WebSocketExtensionFilterProvider
extensionFilterProvider

private final String
extensionName

Constructor Summary

AccessConstructor and Description
pack-priv
DeflateFrameServerExtension(int compressionLevel, String extensionName, WebSocketExtensionFilterProvider extensionFilterProvider)

Method Summary

Modifier and TypeMethod and Description
public WebSocketExtensionDecoder
newExtensionDecoder()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension.newExtensionDecoder.

public WebSocketExtensionEncoder
newExtensionEncoder()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension.newExtensionEncoder.

public WebSocketExtensionData
newReponseData()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtension.newReponseData.

Return an extension configuration to submit to the client as an acknowledge.
public int
rsv()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension.rsv.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

compressionLevelback to summary
private final int compressionLevel
extensionFilterProviderback to summary
private final WebSocketExtensionFilterProvider extensionFilterProvider
extensionNameback to summary
private final String extensionName

Constructor Detail

DeflateFrameServerExtensionback to summary
pack-priv DeflateFrameServerExtension(int compressionLevel, String extensionName, WebSocketExtensionFilterProvider extensionFilterProvider)

Method Detail

newExtensionDecoderback to summary
public WebSocketExtensionDecoder newExtensionDecoder()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension.newExtensionDecoder.

Returns:WebSocketExtensionDecoder

Doc from io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension.newExtensionDecoder.

create the extension decoder.

Annotations
@Override
newExtensionEncoderback to summary
public WebSocketExtensionEncoder newExtensionEncoder()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension.newExtensionEncoder.

Returns:WebSocketExtensionEncoder

Doc from io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension.newExtensionEncoder.

create the extension encoder.

Annotations
@Override
newReponseDataback to summary
public WebSocketExtensionData newReponseData()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtension.newReponseData.

Doc from io.netty.handler.codec.http.websocketx.extensions.WebSocketServerExtension.newReponseData.

Return an extension configuration to submit to the client as an acknowledge.

Returns:WebSocketExtensionData

the acknowledged extension configuration.

Annotations
@Override
rsvback to summary
public int rsv()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension.rsv.

Returns:int

Doc from io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension.rsv.

the reserved bit value to ensure that no other extension should interfere.

Annotations
@Override