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
public class FastLzFrameEncoder extends MessageToByteEncoder<ByteBuf>
Compresses aByteBuf
using the FastLZ algorithm. See FastLZ format.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
-
Constructor Summary
Constructors Constructor Description FastLzFrameEncoder()
Creates 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, java.util.zip.Checksum checksum)
Creates a FastLZ encoder with specified compression level and checksum calculator.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected 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
-
-
-
-
Constructor Detail
-
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
public FastLzFrameEncoder(int level, java.util.zip.Checksum checksum)
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 Detail
-
encode
protected void encode(ChannelHandlerContext ctx, ByteBuf in, ByteBuf out) throws java.lang.Exception
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:
java.lang.Exception
- is thrown if an error occurs
-
-