andreacavalli/netty5
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Clarify SnappyFramedDecoder javadoc to make it as clear as possible regarding the default settings

Browse Source
This commit is contained in:
Luke Wood 2013-05-20 17:31:04 +01:00
parent 81e3c1719a
commit c1cbe8bec3
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
codec/src/main/java/io/netty/handler/codec/compression/SnappyFramedDecoder.java
View File

@ -28,6 +28,12 @@ import static io.netty.handler.codec.compression.Snappy.*;
* Uncompresses a {@link ByteBuf} encoded with the Snappy framing format. * Uncompresses a {@link ByteBuf} encoded with the Snappy framing format.
* *
* See http://code.google.com/p/snappy/source/browse/trunk/framing_format.txt * 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 { public class SnappyFramedDecoder extends ByteToByteDecoder {
enum ChunkType { enum ChunkType {
@ -48,7 +54,8 @@ public class SnappyFramedDecoder extends ByteToByteDecoder {
/** /**
* Creates a new snappy-framed decoder with validation of checksums * 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() { public SnappyFramedDecoder() {
this(false); this(false);