From de2c6acecf2e6ca2d87bfffbc14ca7955fc2a15c Mon Sep 17 00:00:00 2001 From: Norman Maurer Date: Sat, 2 Nov 2013 15:59:33 +0100 Subject: [PATCH] [#1940] Add javadoc to explain how the FileChannel is closed when using DefaultFileRegion --- .../src/main/java/io/netty/channel/DefaultFileRegion.java | 3 +++ 1 file changed, 3 insertions(+) diff --git a/transport/src/main/java/io/netty/channel/DefaultFileRegion.java b/transport/src/main/java/io/netty/channel/DefaultFileRegion.java index 9abb9be851..c2ac264cc6 100644 --- 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 {