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

Javadoc

Browse Source
This commit is contained in:
Trustin Lee 2009-06-18 12:21:46 +00:00
parent f38fb2b742
commit a26ebc2bc1
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/main/java/org/jboss/netty/handler/codec/frame/LengthFieldBasedFrameDecoder.java
View File

@ -38,26 +38,12 @@ import org.jboss.netty.channel.ChannelHandlerContext;
* proprietary client-server protocols. Here are some example that will give
* you the basic idea on which option does what.
*
* <h3>4 bytes length field at offset 0, strip header</h3>
* <pre>
* <b>lengthFieldOffset</b> = <b>0</b>
* <b>lengthFieldLength</b> = <b>4</b>
* <b>lengthAdjustment</b> = <b>0</b>
* <b>initialBytesToStrip</b> = <b>4</b>
*
* BEFORE DECODE (16 bytes) AFTER DECODE (12 bytes)
* +--------------+----------------+ +----------------+
* | Length Field | Actual Content |----->| Actual Content |
* | 0x0000000C | "HELLO, WORLD" | | "HELLO, WORLD" |
* +--------------+----------------+ +----------------+
* </pre>
*
* <h3>2 bytes length field at offset 0, do not strip header</h3>
* <pre>
* <b>lengthFieldOffset</b> = <b>0</b>
* <b>lengthFieldLength</b> = <b>2</b>
* <b>lengthAdjustment</b> = <b>0</b>
* <b>initialBytesToStrip</b> = <b>0</b>
* <b>lengthAdjustment</b> = <b>0</b> (default)
* <b>initialBytesToStrip</b> = <b>0</b> (default)
*
* BEFORE DECODE (14 bytes) AFTER DECODE (14 bytes)
* +--------+----------------+ +--------+----------------+
@ -66,6 +52,20 @@ import org.jboss.netty.channel.ChannelHandlerContext;
* +--------+----------------+ +--------+----------------+
* </pre>
*
* <h3>2 bytes length field at offset 0, strip header</h3>
* <pre>
* <b>lengthFieldOffset</b> = <b>0</b>
* <b>lengthFieldLength</b> = <b>2</b>
* <b>lengthAdjustment</b> = <b>0</b>
* <b>initialBytesToStrip</b> = <b>2</b>
*
* BEFORE DECODE (14 bytes) AFTER DECODE (12 bytes)
* +--------+----------------+ +----------------+
* | Length | Actual Content |----->| Actual Content |
* | 0x000C | "HELLO, WORLD" | | "HELLO, WORLD" |
* +--------+----------------+ +----------------+
* </pre>
*
* <h3>3 bytes length field at the end of 5 bytes header, strip header</h3>
* <pre>
* <b>lengthFieldOffset</b> = <b>2</b> (= 5 - 3)