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

[#5455] Clarify ChannelPool javadocs

Browse Source 
Motivation:

We should make it clear that each acquired Channel needs to be released in all cases.

Modifications:

More clear javadocs.

Result:

Harder for users to leak Channel.
This commit is contained in:
Norman Maurer 2016-07-04 09:40:08 +02:00
parent 7c2f1f5fd7
commit 9a82b76158
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
transport/src/main/java/io/netty/channel/pool/ChannelPool.java
View File

@ -30,12 +30,18 @@ public interface ChannelPool extends Closeable {
/** /**
* Acquire a {@link Channel} from this {@link ChannelPool}. The returned {@link Future} is notified once * Acquire a {@link Channel} from this {@link ChannelPool}. The returned {@link Future} is notified once
* the acquire is successful and failed otherwise. * the acquire is successful and failed otherwise.
*
* <strong>Its important that an acquired is always released to the pool again, even if the {@link Channel}
* is explicitly closed..</strong>
*/ */
Future<Channel> acquire(); Future<Channel> acquire();
/** /**
* Acquire a {@link Channel} from this {@link ChannelPool}. The given {@link Promise} is notified once * Acquire a {@link Channel} from this {@link ChannelPool}. The given {@link Promise} is notified once
* the acquire is successful and failed otherwise. * the acquire is successful and failed otherwise.
*
* <strong>Its important that an acquired is always released to the pool again, even if the {@link Channel}
* is explicitly closed..</strong>
*/ */
Future<Channel> acquire(Promise<Channel> promise); Future<Channel> acquire(Promise<Channel> promise);