[#1940] Add javadoc to explain how the FileChannel is closed when using DefaultFileRegion

2013-11-02 15:59:33 +01:00 · 2013-11-02 15:59:33 +01:00 · de2c6acecf
commit de2c6acecf
parent 208411f9a9
1 changed files with 3 additions and 0 deletions
--- a/transport/src/main/java/io/netty/channel/DefaultFileRegion.java
+++ b/transport/src/main/java/io/netty/channel/DefaultFileRegion.java
@ -25,6 +25,9 @@ import java.nio.channels.WritableByteChannel;

 /**
 * Default {@link FileRegion} implementation which transfer data from a {@link FileChannel}.
+ *
+ * Be aware that the {@link FileChannel} will be automatically closed once {@link #refCnt()} returns
+ * {@code 0}.
 */
 public class DefaultFileRegion extends AbstractReferenceCounted implements FileRegion {