Package io.netty.handler.codec.compression

Class SnappyFrameEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToByteEncoder<io.netty.buffer.ByteBuf>

io.netty.handler.codec.compression.SnappyFrameEncoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelOutboundHandler

Direct Known Subclasses:

SnappyFramedEncoder

public class SnappyFrameEncoder
extends MessageToByteEncoder<io.netty.buffer.ByteBuf>

Compresses a ByteBuf using the Snappy framing format. See Snappy framing format.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
SnappyFrameEncoder()

Method Summary

Modifier and Type	Method	Description
protected void	encode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, io.netty.buffer.ByteBuf out)	Encode a message into a ByteBuf.
static SnappyFrameEncoder	snappyEncoderWithJumboFrames()	Create a new instance with a 65535 chunk size.

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

SnappyFrameEncoder

public SnappyFrameEncoder()

Method Detail

snappyEncoderWithJumboFrames

public static SnappyFrameEncoder snappyEncoderWithJumboFrames()

Create a new instance with a 65535 chunk size.

encode

protected void encode(io.netty.channel.ChannelHandlerContext ctx,
                      io.netty.buffer.ByteBuf in,
                      io.netty.buffer.ByteBuf out)
               throws Exception

Description copied from class: MessageToByteEncoder

Encode a message into a ByteBuf. This method will be called for each written message that can be handled by this encoder.

Specified by:

encode in class MessageToByteEncoder<io.netty.buffer.ByteBuf>

Parameters:

ctx - the ChannelHandlerContext which this MessageToByteEncoder belongs to

in - the message to encode

out - the ByteBuf into which the encoded message will be written

Throws:

Exception - is thrown if an error occurs