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

pack-priv Class PerMessageDeflateEncoder

extends DeflateEncoder
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 compressor.

Field Summary

Modifier and TypeField and Description
private boolean
compressing

Constructor Summary

AccessConstructor and Description
pack-priv
PerMessageDeflateEncoder(int
compression level of the compressor.
compressionLevel, int
maximum size of the window compressor buffer.
windowSize, boolean
true to disable context takeover.
noContext)

Constructor

pack-priv
PerMessageDeflateEncoder(int
compression level of the compressor.
compressionLevel, int
maximum size of the window compressor buffer.
windowSize, boolean
true to disable context takeover.
noContext, WebSocketExtensionFilter
extension filter for per message deflate encoder.
extensionEncoderFilter)

Constructor

Method Summary

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

Overrides io.netty.handler.codec.MessageToMessageEncoder.acceptOutboundMessage.

Returns true if the given message should be handled.
protected void
encode(ChannelHandlerContext
the ChannelHandlerContext which this MessageToMessageEncoder belongs to
ctx, WebSocketFrame
the message to encode to an other one
msg, List<Object>
the List into which the encoded msg should be added needs to do some kind of aggregation
out)

Overrides io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.encode.

Encode from one message to an other.
protected boolean
removeFrameTail(WebSocketFrame
the current frame.
msg)

Implements abstract io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.removeFrameTail.

protected int
rsv(WebSocketFrame
the current frame.
msg)

Implements abstract io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.rsv.

Inherited from io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder:
extensionEncoderFilterhandlerRemoved

Field Detail

compressingback to summary
private boolean compressing

Constructor Detail

PerMessageDeflateEncoderback to summary
pack-priv PerMessageDeflateEncoder(int compressionLevel, int windowSize, boolean noContext)

Constructor

Parameters
compressionLevel:int

compression level of the compressor.

windowSize:int

maximum size of the window compressor buffer.

noContext:boolean

true to disable context takeover.

PerMessageDeflateEncoderback to summary
pack-priv PerMessageDeflateEncoder(int compressionLevel, int windowSize, boolean noContext, WebSocketExtensionFilter extensionEncoderFilter)

Constructor

Parameters
compressionLevel:int

compression level of the compressor.

windowSize:int

maximum size of the window compressor buffer.

noContext:boolean

true to disable context takeover.

extensionEncoderFilter:WebSocketExtensionFilter

extension filter for per message deflate encoder.

Method Detail

acceptOutboundMessageback to summary
public boolean acceptOutboundMessage(Object msg) throws Exception

Overrides io.netty.handler.codec.MessageToMessageEncoder.acceptOutboundMessage.

Doc from io.netty.handler.codec.MessageToMessageEncoder.acceptOutboundMessage.

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

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

Overrides io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.encode.

Doc from io.netty.handler.codec.MessageToMessageEncoder.encode.

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

Parameters
ctx:ChannelHandlerContext

the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg:WebSocketFrame

the message to encode to an other one

out:List<Object>

the List into which the encoded msg should be added needs to do some kind of aggregation

Annotations
@Override
Exceptions
Exception:
is thrown if an error occurs
removeFrameTailback to summary
protected boolean removeFrameTail(WebSocketFrame msg)

Implements abstract io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.removeFrameTail.

Parameters
msg:WebSocketFrame

Doc from io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.removeFrameTail.

the current frame.

Returns:boolean

Doc from io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.removeFrameTail.

true if compressed payload tail needs to be removed.

Annotations
@Override
rsvback to summary
protected int rsv(WebSocketFrame msg)

Implements abstract io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.rsv.

Parameters
msg:WebSocketFrame

Doc from io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.rsv.

the current frame.

Returns:int

Doc from io.netty.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.rsv.

the rsv bits to set in the compressed frame.

Annotations
@Override