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

Make our ChannelFutureListeners less restrictive (#11627)

Browse Source 
Motivation:

Our current ChannelFutureListeners are too restrictive in terms of the type of the context. We should lift this a bit

Modifications:

Refactor ChannelFutureListeners to not be an enum and so allow most of its instances to be used with any ChannelOutboundInvoker.

Result:

More flexible usage
This commit is contained in:
Norman Maurer 2021-08-30 13:14:33 +02:00 committed by GitHub
parent e04f48d802
commit 73377f0fd5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
transport/src/main/java/io/netty/channel/ChannelFutureListeners.java
View File

@ -19,44 +19,38 @@ import io.netty.util.concurrent.Future;
import io.netty.util.concurrent.FutureContextListener; import io.netty.util.concurrent.FutureContextListener;
/** /**
* {@link FutureContextListener} listeners that take a channel context, and listens to the result of a {@link Future}. * {@link FutureContextListener} listeners that take a context, and listens to the result of a {@link Future}.
* The result of the asynchronous {@link Channel} I/O operation is notified once this listener is added by calling * The result of the asynchronous {@link ChannelOutboundInvoker} I/O operation is notified once this listener is added
* {@link Future#addListener(Object, FutureContextListener)} with the {@link Channel} as context. * by calling {@link Future#addListener(Object, FutureContextListener)} with the {@link ChannelOutboundInvoker} /
* {@link Channel} as context.
*/ */
public enum ChannelFutureListeners implements FutureContextListener<Channel, Object> { public final class ChannelFutureListeners {
/**
* A {@link FutureContextListener} that closes the {@link Channel} which is associated with the specified {@link
* Future}.
*/
CLOSE,
/** /**
* A {@link FutureContextListener} that closes the {@link Channel} when the operation ended up with a failure or * A {@link FutureContextListener} that closes the {@link ChannelOutboundInvoker} which is associated with
* cancellation rather than a success. * the specified {@link Future}.
*/ */
CLOSE_ON_FAILURE, public static final FutureContextListener<ChannelOutboundInvoker, Object> CLOSE = (c, f) -> c.close();
/**
* A {@link FutureContextListener} that closes the {@link ChannelOutboundInvoker} when the operation ended up with
* a failure or cancellation rather than a success.
*/
public static final FutureContextListener<ChannelOutboundInvoker, Object> CLOSE_ON_FAILURE = (c, f) -> {
if (f.isFailed()) {
c.close();
}
};
/** /**
* A {@link FutureContextListener} that forwards the {@link Throwable} of the {@link Future} into the {@link * A {@link FutureContextListener} that forwards the {@link Throwable} of the {@link Future} into the {@link
* ChannelPipeline}. This mimics the old behavior of Netty 3. * ChannelPipeline}. This mimics the old behavior of Netty 3.
*/ */
FIRE_EXCEPTION_ON_FAILURE; public static final FutureContextListener<Channel, Object> FIRE_EXCEPTION_ON_FAILURE = (c, f) -> {
if (f.isFailed()) {
c.pipeline().fireExceptionCaught(f.cause());
}
};
@Override private ChannelFutureListeners() { }
public void operationComplete(Channel channel, Future<?> future) throws Exception {
switch (this) {
case CLOSE:
channel.close();
break;
case CLOSE_ON_FAILURE:
if (future.isFailed()) {
channel.close();
}
break;
case FIRE_EXCEPTION_ON_FAILURE:
if (future.isFailed()) {
channel.pipeline().fireExceptionCaught(future.cause());
}
}
}
} }