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

pack-priv Class PerMessageDeflateDecoder

extends DeflateDecoder
Class Inheritance
Imports
io.netty.channel.ChannelHandlerContext, io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame, .ContinuationWebSocketFrame, .TextWebSocketFrame, .WebSocketFrame, io.netty.handler.codec.http.websocketx.extensions.WebSocketExtension, .WebSocketExtensionFilter, java.util.List
Per-message implementation of deflate decompressor.

Field Summary

Modifier and TypeField and Description
private boolean
compressing

Inherited from io.netty.handler.codec.http.websocketx.extensions.compression.DeflateDecoder:
EMPTY_DEFLATE_BLOCKFRAME_TAIL

Constructor Summary

AccessConstructor and Description
pack-priv
PerMessageDeflateDecoder(boolean
true to disable context takeover.
noContext)

Constructor

pack-priv
PerMessageDeflateDecoder(boolean
true to disable context takeover.
noContext, WebSocketExtensionFilter
extension decoder for per message deflate decoder.
extensionDecoderFilter)

Constructor

Method Summary

Modifier and TypeMethod and Description
public boolean
acceptInboundMessage(Object msg)

Overrides io.netty.handler.codec.MessageToMessageDecoder.acceptInboundMessage.

Returns true if the given message should be handled.
protected boolean
appendFrameTail(WebSocketFrame msg)

Implements abstract io.netty.handler.codec.http.websocketx.extensions.compression.DeflateDecoder.appendFrameTail.

protected void
decode(ChannelHandlerContext
the ChannelHandlerContext which this MessageToMessageDecoder belongs to
ctx, WebSocketFrame
the message to decode to an other one
msg, List<Object>
the List to which decoded messages should be added
out)

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

Decode from one message to an other.
protected int
newRsv(WebSocketFrame msg)

Implements abstract io.netty.handler.codec.http.websocketx.extensions.compression.DeflateDecoder.newRsv.

Inherited from io.netty.handler.codec.http.websocketx.extensions.compression.DeflateDecoder:
channelInactiveextensionDecoderFilterhandlerRemoved

Field Detail

compressingback to summary
private boolean compressing

Constructor Detail

PerMessageDeflateDecoderback to summary
pack-priv PerMessageDeflateDecoder(boolean noContext)

Constructor

Parameters
noContext:boolean

true to disable context takeover.

PerMessageDeflateDecoderback to summary
pack-priv PerMessageDeflateDecoder(boolean noContext, WebSocketExtensionFilter extensionDecoderFilter)

Constructor

Parameters
noContext:boolean

true to disable context takeover.

extensionDecoderFilter:WebSocketExtensionFilter

extension decoder for per message deflate decoder.

Method Detail

acceptInboundMessageback to summary
public boolean acceptInboundMessage(Object msg) throws Exception

Overrides io.netty.handler.codec.MessageToMessageDecoder.acceptInboundMessage.

Doc from io.netty.handler.codec.MessageToMessageDecoder.acceptInboundMessage.

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

Annotations
@Override
appendFrameTailback to summary
protected boolean appendFrameTail(WebSocketFrame msg)

Implements abstract io.netty.handler.codec.http.websocketx.extensions.compression.DeflateDecoder.appendFrameTail.

Annotations
@Override
decodeback to summary
protected void decode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out) throws Exception

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

Doc from io.netty.handler.codec.MessageToMessageDecoder.decode.

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

Parameters
ctx:ChannelHandlerContext

the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg:WebSocketFrame

the message to decode to an other one

out:List<Object>

the List to which decoded messages should be added

Annotations
@Override
Exceptions
Exception:
is thrown if an error occurs
newRsvback to summary
protected int newRsv(WebSocketFrame msg)

Implements abstract io.netty.handler.codec.http.websocketx.extensions.compression.DeflateDecoder.newRsv.

Annotations
@Override