Package io.servicetalk.transport.netty.internal

Class NettyChannelListenableAsyncCloseable

java.lang.Object

io.servicetalk.transport.netty.internal.NettyChannelListenableAsyncCloseable

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable

Direct Known Subclasses:

DefaultNettyConnection

public class NettyChannelListenableAsyncCloseable
extends java.lang.Object
implements ListenableAsyncCloseable

Implements ListenableAsyncCloseable using a netty Channel.

Constructor Summary

Constructors

Constructor	Description
NettyChannelListenableAsyncCloseable(io.netty.channel.Channel channel, Executor offloadingExecutor)	New instance.

Method Summary

Modifier and Type	Method	Description
protected io.netty.channel.Channel	channel()	Get access to the underlying Channel.
Completable	closeAsync()	Used to close/shutdown a resource.
Completable	closeAsyncGracefully()	Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing.
protected void	doCloseAsyncGracefully()	Initiate graceful closure.
Completable	onClose()	Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NettyChannelListenableAsyncCloseable

public NettyChannelListenableAsyncCloseable(io.netty.channel.Channel channel,
                                            Executor offloadingExecutor)

New instance.

Parameters:

channel - to use.

offloadingExecutor - Executor used to offload any signals to any asynchronous created by this NettyChannelListenableAsyncCloseable which could interact with the EventLoop.

Method Detail

closeAsync

public final Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

closeAsyncGracefully

public final Completable closeAsyncGracefully()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource, similar to AsyncCloseable.closeAsync(), but attempts to cleanup state before abruptly closing. This provides a hint that implementations can use to stop accepting new work and finish in flight work. This method is implemented on a "best effort" basis and may be equivalent to AsyncCloseable.closeAsync().

Note: Implementations may or may not apply a timeout for this operation to complete, if a caller does not want to wait indefinitely, and are unsure if the implementation applies a timeout, it is advisable to apply a timeout and force a call to AsyncCloseable.closeAsync().

Specified by:

closeAsyncGracefully in interface AsyncCloseable

Returns:

A Completable that is notified once the close is complete.

onClose

public final Completable onClose()

Description copied from interface: ListenableAsyncCloseable

Returns a Completable that is notified once the ListenableAsyncCloseable was closed.

Specified by:

onClose in interface ListenableAsyncCloseable

Returns:

the Completable that is notified on close.

channel

protected final io.netty.channel.Channel channel()

Get access to the underlying Channel.

Returns:

the underlying Channel.

doCloseAsyncGracefully

protected void doCloseAsyncGracefully()

Initiate graceful closure.