Top Description Inners Fields Constructors Methods
io.netty5.channel

public final Class ChannelFutureListeners

extends Object
Class Inheritance
Imports
io.netty5.util.concurrent.Future, .FutureContextListener
FutureContextListener listeners that take a context, and listens to the result of a Future. The result of the asynchronous ChannelOutboundInvoker I/O operation is notified once this listener is added by calling Future#addListener(Object, FutureContextListener) with the ChannelOutboundInvoker / Channel as context.

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
ChannelFutureListeners.Close

private static class
ChannelFutureListeners.CloseOnFailure

private static class
ChannelFutureListeners.FireExceptionOnFailure

Field Summary

Modifier and TypeField and Description
public static final FutureContextListener<ChannelOutboundInvoker, Object>
CLOSE

A FutureContextListener that closes the ChannelOutboundInvoker which is associated with the specified Future.

public static final FutureContextListener<ChannelOutboundInvoker, Object>
CLOSE_ON_FAILURE

A FutureContextListener that closes the ChannelOutboundInvoker when the operation ended up with a failure or cancellation rather than a success.

public static final FutureContextListener<Channel, Object>
FIRE_EXCEPTION_ON_FAILURE

A FutureContextListener that forwards the Throwable of the Future into the ChannelPipeline.

Constructor Summary

AccessConstructor and Description
private
ChannelFutureListeners()

Method Summary

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

CLOSEback to summary
public static final FutureContextListener<ChannelOutboundInvoker, Object> CLOSE

A FutureContextListener that closes the ChannelOutboundInvoker which is associated with the specified Future.

CLOSE_ON_FAILUREback to summary
public static final FutureContextListener<ChannelOutboundInvoker, Object> CLOSE_ON_FAILURE

A FutureContextListener that closes the ChannelOutboundInvoker when the operation ended up with a failure or cancellation rather than a success.

FIRE_EXCEPTION_ON_FAILUREback to summary
public static final FutureContextListener<Channel, Object> FIRE_EXCEPTION_ON_FAILURE

A FutureContextListener that forwards the Throwable of the Future into the ChannelPipeline. This mimics the old behavior of Netty 3.

Constructor Detail

ChannelFutureListenersback to summary
private ChannelFutureListeners()
io.netty5.channel back to summary

private final Class ChannelFutureListeners.Close

extends Object
implements FutureContextListener<ChannelOutboundInvoker, Object>
Class Inheritance
All Implemented Interfaces
io.netty5.util.concurrent.FutureContextListener

Constructor Summary

AccessConstructor and Description
private
Close()

Method Summary

Modifier and TypeMethod and Description
public void
operationComplete(ChannelOutboundInvoker context, Future<?>
the source Future which called this callback
future)

Implements io.netty5.util.concurrent.FutureContextListener.operationComplete.

Invoked when the operation associated with the Future has been completed.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

Closeback to summary
private Close()

Method Detail

operationCompleteback to summary
public void operationComplete(ChannelOutboundInvoker context, Future<?> future) throws Exception

Implements io.netty5.util.concurrent.FutureContextListener.operationComplete.

Doc from io.netty5.util.concurrent.FutureContextListener.operationComplete.

Invoked when the operation associated with the Future has been completed.

Parameters
future:Future<?>

the source Future which called this callback

Annotations
@Override
io.netty5.channel back to summary

private final Class ChannelFutureListeners.CloseOnFailure

extends Object
implements FutureContextListener<ChannelOutboundInvoker, Object>
Class Inheritance
All Implemented Interfaces
io.netty5.util.concurrent.FutureContextListener

Constructor Summary

AccessConstructor and Description
private
CloseOnFailure()

Method Summary

Modifier and TypeMethod and Description
public void
operationComplete(ChannelOutboundInvoker context, Future<?>
the source Future which called this callback
future)

Implements io.netty5.util.concurrent.FutureContextListener.operationComplete.

Invoked when the operation associated with the Future has been completed.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

CloseOnFailureback to summary
private CloseOnFailure()

Method Detail

operationCompleteback to summary
public void operationComplete(ChannelOutboundInvoker context, Future<?> future) throws Exception

Implements io.netty5.util.concurrent.FutureContextListener.operationComplete.

Doc from io.netty5.util.concurrent.FutureContextListener.operationComplete.

Invoked when the operation associated with the Future has been completed.

Parameters
future:Future<?>

the source Future which called this callback

Annotations
@Override
io.netty5.channel back to summary

private final Class ChannelFutureListeners.FireExceptionOnFailure

extends Object
implements FutureContextListener<Channel, Object>
Class Inheritance
  • java.lang.Object
  • io.netty5.channel.ChannelFutureListeners.FireExceptionOnFailure
All Implemented Interfaces
io.netty5.util.concurrent.FutureContextListener

Constructor Summary

AccessConstructor and Description
private
FireExceptionOnFailure()

Method Summary

Modifier and TypeMethod and Description
public void
operationComplete(Channel context, Future<?>
the source Future which called this callback
future)

Implements io.netty5.util.concurrent.FutureContextListener.operationComplete.

Invoked when the operation associated with the Future has been completed.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

FireExceptionOnFailureback to summary
private FireExceptionOnFailure()

Method Detail

operationCompleteback to summary
public void operationComplete(Channel context, Future<?> future) throws Exception

Implements io.netty5.util.concurrent.FutureContextListener.operationComplete.

Doc from io.netty5.util.concurrent.FutureContextListener.operationComplete.

Invoked when the operation associated with the Future has been completed.

Parameters
future:Future<?>

the source Future which called this callback

Annotations
@Override