More Javadoc on the return value of ChannelFuture.setSuccess and setFailure

This commit is contained in:
Trustin Lee 2008-11-26 09:23:37 +00:00
parent 6e40f62574
commit 0886c11645

View File

@ -96,12 +96,20 @@ public interface ChannelFuture {
/**
* Marks this future as a success and notifies all
* listeners.
*
* @return {@code true} if and only if successfully marked this future as
* a success. Otherwise {@code false} because this future is
* already marked as either a success or a failure.
*/
boolean setSuccess();
/**
* Marks this future as a failure and notifies all
* listeners.
*
* @return {@code true} if and only if successfully marked this future as
* a failure. Otherwise {@code false} because this future is
* already marked as either a success or a failure.
*/
boolean setFailure(Throwable cause);