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

Class DeflateDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<WebSocketFrame>

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

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

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

Direct Known Subclasses:

PerFrameDeflateDecoder, PerMessageDeflateDecoder

abstract class DeflateDecoder
extends WebSocketExtensionDecoder

Deflate implementation of a payload decompressor for io.netty.handler.codec.http.websocketx.WebSocketFrame.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private EmbeddedChannel	decoder
(package private) static final ByteBuf	EMPTY_DEFLATE_BLOCK
private final WebSocketExtensionFilter	extensionDecoderFilter
(package private) static final ByteBuf	FRAME_TAIL
private final int	maxAllocation
private final boolean	noContext

Constructor Summary

Constructors

Constructor	Description
DeflateDecoder(boolean noContext, WebSocketExtensionFilter extensionDecoderFilter, int maxAllocation)	Constructor

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	appendFrameTail(WebSocketFrame msg)
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
private void	cleanup()
protected void	decode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out)	Decode from one message to an other.
private ByteBuf	decompressContent(ChannelHandlerContext ctx, WebSocketFrame msg)
protected WebSocketExtensionFilter	extensionDecoderFilter()	Returns the extension decoder filter.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
protected abstract int	newRsv(WebSocketFrame msg)

Methods inherited from class io.netty.handler.codec.MessageToMessageDecoder

acceptInboundMessage, channelRead, channelReadComplete

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded

Field Details

FRAME_TAIL

static final ByteBuf FRAME_TAIL

EMPTY_DEFLATE_BLOCK

static final ByteBuf EMPTY_DEFLATE_BLOCK

noContext

private final boolean noContext

extensionDecoderFilter

private final WebSocketExtensionFilter extensionDecoderFilter

maxAllocation

private final int maxAllocation

decoder

private EmbeddedChannel decoder

Constructor Details

DeflateDecoder

DeflateDecoder(boolean noContext,
 WebSocketExtensionFilter extensionDecoderFilter,
 int maxAllocation)

Constructor

Parameters:

noContext - true to disable context takeover.

extensionDecoderFilter - extension decoder filter.

Method Details

extensionDecoderFilter

protected WebSocketExtensionFilter extensionDecoderFilter()

Returns the extension decoder filter.

appendFrameTail

protected abstract boolean appendFrameTail(WebSocketFrame msg)

newRsv

protected abstract int newRsv(WebSocketFrame msg)

decode

protected void decode(ChannelHandlerContext ctx,
 WebSocketFrame msg,
 List<Object> out)
               throws Exception

Description copied from class: MessageToMessageDecoder

Decode from one message to an other. This method will be called for each written message that can be handled by this decoder.

Specified by:

decode in class MessageToMessageDecoder<WebSocketFrame>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to an other one

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class ChannelHandlerAdapter

Throws:

Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class ChannelInboundHandlerAdapter

Throws:

Exception

decompressContent

private ByteBuf decompressContent(ChannelHandlerContext ctx,
 WebSocketFrame msg)

cleanup

private void cleanup()