Netty 5.0.0.Alpha5 · io.netty5.handler.codec.http.websocketx.extensions.compression.DeflateDecoder

Modifier and Type	Field and Description
private EmbeddedChannel	decoder
private final WebSocketExtensionFilter	extensionDecoderFilter
pack-priv static final Supplier<Buffer>	FRAME_TAIL
pack-priv static final int	FRAME_TAIL_LENGTH
private final boolean	noContext

Access	Constructor and Description
pack-priv	DeflateDecoder(boolean true to disable context takeover. noContext, WebSocketExtensionFilter extension decoder filter. extensionDecoderFilter) Constructor

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	appendFrameTail(WebSocketFrame msg)
public void	channelInactive(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime.
private void	cleanup()
protected final void	decode(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to ctx, WebSocketFrame the message to decode to another one msg) Overrides io.netty5.handler.codec.MessageToMessageDecoder.decode. Decode from one message to another.
protected void	decodeAndClose(ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to ctx, WebSocketFrame the message to decode to another one msg) Overrides io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose. Decode from one message to another.
private Buffer	decompressContent(ChannelHandlerContext ctx, WebSocketFrame msg)
protected WebSocketExtensionFilter	extensionDecoderFilter() Returns the extension decoder filter.
public void	handlerRemoved(ChannelHandlerContext ctx) Overrides default io.netty5.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore.
private static boolean	isEmptyDeflateBlock(Buffer binaryData)
protected abstract int	newRsv(WebSocketFrame msg)

decoder	back to summary
private EmbeddedChannel decoder

extensionDecoderFilter	back to summary
private final WebSocketExtensionFilter extensionDecoderFilter

FRAME_TAIL	back to summary
pack-priv static final Supplier<Buffer> FRAME_TAIL

FRAME_TAIL_LENGTH	back to summary
pack-priv static final int FRAME_TAIL_LENGTH

noContext	back to summary
private final boolean noContext

DeflateDecoder	back to summary
pack-priv DeflateDecoder(boolean noContext, WebSocketExtensionFilter extensionDecoderFilter) Constructor Parameters noContext:boolean true to disable context takeover. extensionDecoderFilter:WebSocketExtensionFilter extension decoder filter.

Method Detail

appendFrameTail	back to summary
protected abstract boolean appendFrameTail(WebSocketFrame msg)

channelInactive back to summary

channelInactive	back to summary
public void channelInactive(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.channelInactive. Doc from io.netty5.channel.ChannelHandler.channelInactive. The `Channel` of the `ChannelHandlerContext` was registered is now inactive and reached its end of lifetime. Annotations @Override

public void channelInactive(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.channelInactive.

Doc from io.netty5.channel.ChannelHandler.channelInactive.

The Channel of the ChannelHandlerContext was registered is now inactive and reached its end of lifetime.

Annotations

@Override

cleanup	back to summary
private void cleanup()

decode back to summary

decode	back to summary
protected final void decode(ChannelHandlerContext ctx, WebSocketFrame msg) throws Exception Overrides io.netty5.handler.codec.MessageToMessageDecoder.decode. Doc from io.netty5.handler.codec.MessageToMessageDecoder.decode. Decode from one message to another. This method will be called for each written message that can be handled by this decoder. The message will be disposed of after this call. Subclasses that wish to sometimes pass messages through, should instead override the `decodeAndClose(ChannelHandlerContext, Object)` method. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to msg:WebSocketFrame the message to decode to another one Annotations @Override Exceptions Exception: is thrown if an error occurs

protected final void decode(ChannelHandlerContext ctx, WebSocketFrame msg) throws Exception

Overrides io.netty5.handler.codec.MessageToMessageDecoder.decode.

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

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

The message will be disposed of after this call.

Subclasses that wish to sometimes pass messages through, should instead override the decodeAndClose(ChannelHandlerContext, Object) method.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
msg:WebSocketFrame: the message to decode to another one

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

decodeAndClose back to summary

decodeAndClose	back to summary
protected void decodeAndClose(ChannelHandlerContext ctx, WebSocketFrame msg) throws Exception Overrides io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose. Doc from io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose. Decode from one message to another. This method will be called for each written message that can be handled by this decoder. The message will not be automatically disposed of after this call. Instead, the responsibility of ensuring that messages are disposed of falls upon the implementor of this method. Subclasses that wish to have incoming messages automatically disposed of should instead override the `decodeAndClose(ChannelHandlerContext, Object)` method. Parameters ctx:ChannelHandlerContext the `ChannelHandlerContext` which this `MessageToMessageDecoder` belongs to msg:WebSocketFrame the message to decode to another one Annotations @Override Exceptions Exception: is thrown if an error occurs

protected void decodeAndClose(ChannelHandlerContext ctx, WebSocketFrame msg) throws Exception

Overrides io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose.

Doc from io.netty5.handler.codec.MessageToMessageDecoder.decodeAndClose.

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

The message will not be automatically disposed of after this call. Instead, the responsibility of ensuring that messages are disposed of falls upon the implementor of this method.

Subclasses that wish to have incoming messages automatically disposed of should instead override the decodeAndClose(ChannelHandlerContext, Object) method.

Parameters

ctx:ChannelHandlerContext: the ChannelHandlerContext which this MessageToMessageDecoder belongs to
msg:WebSocketFrame: the message to decode to another one

Annotations

@Override

Exceptions

Exception:: is thrown if an error occurs

decompressContent	back to summary
private Buffer decompressContent(ChannelHandlerContext ctx, WebSocketFrame msg)

extensionDecoderFilter	back to summary
protected WebSocketExtensionFilter extensionDecoderFilter() Returns the extension decoder filter.

handlerRemoved back to summary

handlerRemoved	back to summary
public void handlerRemoved(ChannelHandlerContext ctx) throws Exception Overrides default io.netty5.channel.ChannelHandler.handlerRemoved. Doc from io.netty5.channel.ChannelHandler.handlerRemoved. Gets called after the `ChannelHandler` was removed from the actual context and it doesn't handle events anymore. Annotations @Override

public void handlerRemoved(ChannelHandlerContext ctx) throws Exception

Overrides default io.netty5.channel.ChannelHandler.handlerRemoved.

Doc from io.netty5.channel.ChannelHandler.handlerRemoved.

Gets called after the ChannelHandler was removed from the actual context and it doesn't handle events anymore.

Annotations

@Override

isEmptyDeflateBlock	back to summary
private static boolean isEmptyDeflateBlock(Buffer binaryData)

newRsv	back to summary
protected abstract int newRsv(WebSocketFrame msg)

pack-priv abstract Class DeflateDecoder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail