From c1cbe8bec399efa8b5dc6d26397a8fc81767ed5e Mon Sep 17 00:00:00 2001 From: Luke Wood Date: Mon, 20 May 2013 17:31:04 +0100 Subject: [PATCH] Clarify SnappyFramedDecoder javadoc to make it as clear as possible regarding the default settings --- .../handler/codec/compression/SnappyFramedDecoder.java | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/codec/src/main/java/io/netty/handler/codec/compression/SnappyFramedDecoder.java b/codec/src/main/java/io/netty/handler/codec/compression/SnappyFramedDecoder.java index 6c26d67292..d10c5b7999 100644 --- a/codec/src/main/java/io/netty/handler/codec/compression/SnappyFramedDecoder.java +++ b/codec/src/main/java/io/netty/handler/codec/compression/SnappyFramedDecoder.java @@ -28,6 +28,12 @@ import static io.netty.handler.codec.compression.Snappy.*; * Uncompresses a {@link ByteBuf} encoded with the Snappy framing format. * * See http://code.google.com/p/snappy/source/browse/trunk/framing_format.txt + * + * Note that by default, validation of the checksum header in each chunk is + * DISABLED for performance improvements. If performance is less of an issue, + * or if you would prefer the safety that checksum validation brings, please + * use the {@link #SnappyFramedDecoder(boolean)} constructor with the argument + * set to {@code true}. */ public class SnappyFramedDecoder extends ByteToByteDecoder { enum ChunkType { @@ -48,7 +54,8 @@ public class SnappyFramedDecoder extends ByteToByteDecoder { /** * Creates a new snappy-framed decoder with validation of checksums - * turned off + * turned OFF. To turn checksum validation on, please use the alternate + * {@link #SnappyFramedDecoder(boolean)} constructor. */ public SnappyFramedDecoder() { this(false);