Class FastLzFrameEncoder
java.lang.Object
io.netty.channel.ChannelHandlerAdapter
io.netty.channel.ChannelOutboundHandlerAdapter
io.netty.handler.codec.MessageToByteEncoder<ByteBuf>
io.netty.handler.codec.compression.FastLzFrameEncoder
- All Implemented Interfaces:
ChannelHandler
,ChannelOutboundHandler
Compresses a
ByteBuf
using the FastLZ algorithm.
See FastLZ format.-
Nested Class Summary
Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ByteBufChecksum
Underlying checksum calculator in use.private final int
Compression level. -
Constructor Summary
ConstructorsConstructorDescriptionCreates a FastLZ encoder without checksum calculator and with auto detection of compression level.FastLzFrameEncoder
(boolean validateChecksums) Creates a FastLZ encoder with auto detection of compression level and calculation of checksums as specified.FastLzFrameEncoder
(int level) Creates a FastLZ encoder with specified compression level and without checksum calculator.FastLzFrameEncoder
(int level, Checksum checksum) Creates a FastLZ encoder with specified compression level and checksum calculator. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
encode
(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out) Encode a message into aByteBuf
.Methods inherited from class io.netty.handler.codec.MessageToByteEncoder
acceptOutboundMessage, allocateBuffer, isPreferDirect, write
Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter
bind, close, connect, deregister, disconnect, flush, read
Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface io.netty.channel.ChannelHandler
exceptionCaught, handlerAdded, handlerRemoved
-
Field Details
-
level
private final int levelCompression level. -
checksum
Underlying checksum calculator in use.
-
-
Constructor Details
-
FastLzFrameEncoder
public FastLzFrameEncoder()Creates a FastLZ encoder without checksum calculator and with auto detection of compression level. -
FastLzFrameEncoder
public FastLzFrameEncoder(int level) Creates a FastLZ encoder with specified compression level and without checksum calculator.- Parameters:
level
- supports only these values: 0 - Encoder will choose level automatically depending on the length of the input buffer. 1 - Level 1 is the fastest compression and generally useful for short data. 2 - Level 2 is slightly slower but it gives better compression ratio.
-
FastLzFrameEncoder
public FastLzFrameEncoder(boolean validateChecksums) Creates a FastLZ encoder with auto detection of compression level and calculation of checksums as specified.- Parameters:
validateChecksums
- If true, the checksum of each block will be calculated and this value will be added to the header of block. By defaultFastLzFrameEncoder
usesAdler32
for checksum calculation.
-
FastLzFrameEncoder
Creates a FastLZ encoder with specified compression level and checksum calculator.- Parameters:
level
- supports only these values: 0 - Encoder will choose level automatically depending on the length of the input buffer. 1 - Level 1 is the fastest compression and generally useful for short data. 2 - Level 2 is slightly slower but it gives better compression ratio.checksum
- theChecksum
instance to use to check data for integrity. You may setnull
if you don't want to validate checksum of each block.
-
-
Method Details
-
encode
Description copied from class:MessageToByteEncoder
Encode a message into aByteBuf
. This method will be called for each written message that can be handled by this encoder.- Specified by:
encode
in classMessageToByteEncoder<ByteBuf>
- Parameters:
ctx
- theChannelHandlerContext
which thisMessageToByteEncoder
belongs toin
- the message to encodeout
- theByteBuf
into which the encoded message will be written- Throws:
Exception
- is thrown if an error occurs
-