Class PerMessageDeflateDecoder

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

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

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

class PerMessageDeflateDecoder
extends DeflateDecoder

Per-message implementation of deflate decompressor.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	compressing

Fields inherited from class DeflateDecoder

EMPTY_DEFLATE_BLOCK, FRAME_TAIL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	acceptInboundMessage(Object msg)	Returns true if the given message should be handled.
protected boolean	appendFrameTail(WebSocketFrame msg)
protected void	decode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out)	Decode from one message to an other.
protected int	newRsv(WebSocketFrame msg)

Methods inherited from class DeflateDecoder

channelInactive, extensionDecoderFilter, handlerRemoved

Methods inherited from class MessageToMessageDecoder

channelRead, channelReadComplete

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class Object

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

Methods inherited from interface ChannelHandler

handlerAdded

Field Details

compressing

private boolean compressing

Constructor Details

PerMessageDeflateDecoder

PerMessageDeflateDecoder(boolean noContext,
 int maxAllocation)

Constructor

Parameters:

noContext - true to disable context takeover.

maxAllocation - maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.

PerMessageDeflateDecoder

PerMessageDeflateDecoder(boolean noContext,
 WebSocketExtensionFilter extensionDecoderFilter,
 int maxAllocation)

Constructor

Parameters:

noContext - true to disable context takeover.

extensionDecoderFilter - extension decoder for per message deflate decoder.

maxAllocation - maximum size of the decompression buffer. Must be >= 0. If zero, maximum size is not limited.

Method Details

acceptInboundMessage

public boolean acceptInboundMessage(Object msg)
                             throws Exception

Description copied from class: MessageToMessageDecoder

Returns true if the given message should be handled. If false it will be passed to the next ChannelInboundHandler in the ChannelPipeline.

Overrides:

acceptInboundMessage in class MessageToMessageDecoder<WebSocketFrame>

Throws:

Exception

newRsv

protected int newRsv(WebSocketFrame msg)

Specified by:

newRsv in class DeflateDecoder

appendFrameTail

protected boolean appendFrameTail(WebSocketFrame msg)

Specified by:

appendFrameTail in class DeflateDecoder

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.

Overrides:

decode in class DeflateDecoder

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