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

public final Class DeflateFrameClientExtensionHandshaker

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

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
DeflateFrameClientExtensionHandshaker.DeflateFrameClientExtension

Field Summary

Modifier and TypeField and Description
private final int
compressionLevel

private final WebSocketExtensionFilterProvider
extensionFilterProvider

private final boolean
useWebkitExtensionName

Constructor Summary

AccessConstructor and Description
public
DeflateFrameClientExtensionHandshaker(boolean useWebkitExtensionName)

Constructor with default configuration.

public
DeflateFrameClientExtensionHandshaker(int
Compression level between 0 and 9 (default is 6).
compressionLevel, boolean useWebkitExtensionName)

Constructor with custom configuration.

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

Constructor with custom configuration.

Method Summary

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

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

Handshake based on server response.
public WebSocketExtensionData
newRequestData()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketClientExtensionHandshaker.newRequestData.

Return extension configuration to submit to the server.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

compressionLevelback to summary
private final int compressionLevel
extensionFilterProviderback to summary
private final WebSocketExtensionFilterProvider extensionFilterProvider
useWebkitExtensionNameback to summary
private final boolean useWebkitExtensionName

Constructor Detail

DeflateFrameClientExtensionHandshakerback to summary
public DeflateFrameClientExtensionHandshaker(boolean useWebkitExtensionName)

Constructor with default configuration.

DeflateFrameClientExtensionHandshakerback to summary
public DeflateFrameClientExtensionHandshaker(int compressionLevel, boolean useWebkitExtensionName)

Constructor with custom configuration.

Parameters
compressionLevel:int

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

DeflateFrameClientExtensionHandshakerback to summary
public DeflateFrameClientExtensionHandshaker(int compressionLevel, boolean useWebkitExtensionName, WebSocketExtensionFilterProvider extensionFilterProvider)

Constructor with custom configuration.

Parameters
compressionLevel:int

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

extensionFilterProvider:WebSocketExtensionFilterProvider

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

Method Detail

handshakeExtensionback to summary
public WebSocketClientExtension handshakeExtension(WebSocketExtensionData extensionData)

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

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

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

Parameters
extensionData:WebSocketExtensionData

the extension configuration sent by the server.

Returns:WebSocketClientExtension

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

Annotations
@Override
newRequestDataback to summary
public WebSocketExtensionData newRequestData()

Implements io.netty.handler.codec.http.websocketx.extensions.WebSocketClientExtensionHandshaker.newRequestData.

Doc from io.netty.handler.codec.http.websocketx.extensions.WebSocketClientExtensionHandshaker.newRequestData.

Return extension configuration to submit to the server.

Returns:WebSocketExtensionData

the desired extension configuration.

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

private Class DeflateFrameClientExtensionHandshaker.DeflateFrameClientExtension

extends Object
implements WebSocketClientExtension
Class Inheritance
  • java.lang.Object
  • io.netty.handler.codec.http.websocketx.extensions.compression.DeflateFrameClientExtensionHandshaker.DeflateFrameClientExtension
All Implemented Interfaces
io.netty.handler.codec.http.websocketx.extensions.WebSocketClientExtension, io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension

Field Summary

Modifier and TypeField and Description
private final int
compressionLevel

private final WebSocketExtensionFilterProvider
extensionFilterProvider

Constructor Summary

AccessConstructor and Description
pack-priv
DeflateFrameClientExtension(int compressionLevel, 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 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

Constructor Detail

DeflateFrameClientExtensionback to summary
pack-priv DeflateFrameClientExtension(int compressionLevel, 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
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