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

pack-priv Class PerFrameDeflateEncoder

extends DeflateEncoder
Class Inheritance
Imports
io.netty5.handler.codec.http.websocketx.BinaryWebSocketFrame, .ContinuationWebSocketFrame, .TextWebSocketFrame, .WebSocketFrame, io.netty5.handler.codec.http.websocketx.extensions.WebSocketExtension, .WebSocketExtensionFilter
Per-frame implementation of deflate compressor.

Field Summary

Inherited from io.netty5.handler.codec.http.websocketx.extensions.compression.DeflateEncoder:
EMPTY_DEFLATE_BLOCK

Constructor Summary

AccessConstructor and Description
pack-priv
PerFrameDeflateEncoder(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
PerFrameDeflateEncoder(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 encoder filter for per frame deflate encoder.
extensionEncoderFilter)

Constructor

Method Summary

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

Overrides io.netty5.handler.codec.MessageToMessageEncoder.acceptOutboundMessage.

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

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

protected int
rsv(WebSocketFrame
the current frame.
msg)

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

Inherited from io.netty5.handler.codec.http.websocketx.extensions.compression.DeflateEncoder:
encodeAndCloseextensionEncoderFilterhandlerRemoved

Constructor Detail

PerFrameDeflateEncoderback to summary
pack-priv PerFrameDeflateEncoder(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.

PerFrameDeflateEncoderback to summary
pack-priv PerFrameDeflateEncoder(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 encoder filter for per frame deflate encoder.

Method Detail

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

Overrides io.netty5.handler.codec.MessageToMessageEncoder.acceptOutboundMessage.

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

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

Annotations
@Override
removeFrameTailback to summary
protected boolean removeFrameTail(WebSocketFrame msg)

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

Parameters
msg:WebSocketFrame

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

the current frame.

Returns:boolean

Doc from io.netty5.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.netty5.handler.codec.http.websocketx.extensions.compression.DeflateEncoder.rsv.

Parameters
msg:WebSocketFrame

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

the current frame.

Returns:int

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

the rsv bits to set in the compressed frame.

Annotations
@Override