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

Improve ChannelBufferInputStream documentation

Browse Source
This commit is contained in:
Trustin Lee 2012-03-26 18:10:16 +09:00
parent a81fa75c59
commit c28137b0b2
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
buffer/src/main/java/io/netty/buffer/ChannelBufferInputStream.java
View File

@ -26,7 +26,10 @@ import java.io.InputStream;
* <p>
* A read operation against this stream will occur at the {@code readerIndex}
* of its underlying buffer and the {@code readerIndex} will increase during
* the read operation.
* the read operation. Please note that it only reads up to the number of
* readable bytes determined at the moment of construction. Therefore,
* updating {@link ChannelBuffer#writerIndex()} will not affect the return
* value of {@link #available()}.
* <p>
* This stream implements {@link DataInput} for your convenience.
* The endianness of the stream is not always big endian but depends on