Class PerMessageDeflateEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

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

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

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

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

class PerMessageDeflateEncoder
extends DeflateEncoder

Per-message implementation of deflate compressor.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	compressing

Constructor Summary

Constructors

Constructor	Description
PerMessageDeflateEncoder(int compressionLevel, int windowSize, boolean noContext)	Constructor
PerMessageDeflateEncoder(int compressionLevel, int windowSize, boolean noContext, WebSocketExtensionFilter extensionEncoderFilter)	Constructor

Method Summary

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(Object msg)	Returns true if the given message should be handled.
protected void	encode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out)	Encode from one message to an other.
protected boolean	removeFrameTail(WebSocketFrame msg)
protected int	rsv(WebSocketFrame msg)

Methods inherited from class DeflateEncoder

extensionEncoderFilter, handlerRemoved

Methods inherited from class MessageToMessageEncoder

write

Methods inherited from class ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, isSharable

Methods inherited from class Object

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

Methods inherited from interface ChannelHandler

exceptionCaught, handlerAdded

Field Details

compressing

private boolean compressing

Constructor Details

PerMessageDeflateEncoder

PerMessageDeflateEncoder(int compressionLevel,
 int windowSize,
 boolean noContext)

Constructor

Parameters:

compressionLevel - compression level of the compressor.

windowSize - maximum size of the window compressor buffer.

noContext - true to disable context takeover.

PerMessageDeflateEncoder

PerMessageDeflateEncoder(int compressionLevel,
 int windowSize,
 boolean noContext,
 WebSocketExtensionFilter extensionEncoderFilter)

Constructor

Parameters:

compressionLevel - compression level of the compressor.

windowSize - maximum size of the window compressor buffer.

noContext - true to disable context takeover.

extensionEncoderFilter - extension filter for per message deflate encoder.

Method Details

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

Description copied from class: MessageToMessageEncoder

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

Overrides:

acceptOutboundMessage in class MessageToMessageEncoder<WebSocketFrame>

Throws:

Exception

rsv

protected int rsv(WebSocketFrame msg)

Specified by:

rsv in class DeflateEncoder

Parameters:

msg - the current frame.

Returns:

the rsv bits to set in the compressed frame.

removeFrameTail

protected boolean removeFrameTail(WebSocketFrame msg)

Specified by:

removeFrameTail in class DeflateEncoder

Parameters:

msg - the current frame.

Returns:

true if compressed payload tail needs to be removed.

encode

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

Description copied from class: MessageToMessageEncoder

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

Overrides:

encode in class DeflateEncoder

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

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

Throws:

Exception - is thrown if an error occurs