io.netty.handler.codec.compression

Class SnappyFramedDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundByteHandlerAdapter

io.netty.handler.codec.ByteToByteDecoder

io.netty.handler.codec.compression.SnappyFramedDecoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundByteHandler, io.netty.channel.ChannelStateHandler

public class SnappyFramedDecoder
extends ByteToByteDecoder

Uncompresses a ByteBuf encoded with the Snappy framing format. See http://code.google.com/p/snappy/source/browse/trunk/framing_format.txt

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
SnappyFramedDecoder() Creates a new snappy-framed decoder with validation of checksums turned off
SnappyFramedDecoder(boolean validateChecksums) Creates a new snappy-framed decoder with validation of checksums as specified.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, io.netty.buffer.ByteBuf out) Decode the from one ByteBuf to an other.

Methods inherited from class io.netty.handler.codec.ByteToByteDecoder

channelInactive, decodeLast, inboundBufferUpdated, isSingleDecode, setSingleDecode

Methods inherited from class io.netty.channel.ChannelInboundByteHandlerAdapter

discardInboundReadBytes, inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

exceptionCaught, handlerAdded, handlerRemoved

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.ChannelStateHandler

channelActive, channelReadSuspended, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

SnappyFramedDecoder

public SnappyFramedDecoder()

Creates a new snappy-framed decoder with validation of checksums turned off

SnappyFramedDecoder

public SnappyFramedDecoder(boolean validateChecksums)

Creates a new snappy-framed decoder with validation of checksums as specified.

Parameters:

validateChecksums - If true, the checksum field will be validated against the actual uncompressed data, and if the checksums do not match, a suitable CompressionException will be thrown

Method Detail

decode

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

Description copied from class: ByteToByteDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read anymore or till nothing was read from the input ByteBuf.

Specified by:

decode in class ByteToByteDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToByteDecoder belongs to

in - the ByteBuf from which to read data

out - the ByteBuf to which the decoded data will be written

Throws:

Exception - is thrown if an error accour