io.servicetalk.transport.netty.internal

Class ChannelSet

java.lang.Object

io.servicetalk.transport.netty.internal.ChannelSet

All Implemented Interfaces:

AsyncCloseable, ListenableAsyncCloseable

public final class ChannelSet
extends java.lang.Object
implements ListenableAsyncCloseable

Manages a set of Channels to provide a mechanism for closing all of them.

Channels are removed from the set when they are closed.

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.util.AttributeKey<AsyncCloseable>	CHANNEL_CLOSEABLE_KEY

Constructor Summary

Constructors

Constructor and Description
ChannelSet(Executor offloadingExecutor) New instance.

Method Summary

Modifier and Type	Method and Description
boolean	addIfAbsent(io.netty.channel.Channel channel) Add a Channel to this ChannelSet, if it is not already present.
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.
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

Field Detail

CHANNEL_CLOSEABLE_KEY

public static final io.netty.util.AttributeKey<AsyncCloseable> CHANNEL_CLOSEABLE_KEY

Constructor Detail

ChannelSet

public ChannelSet(Executor offloadingExecutor)

New instance.

Parameters:

offloadingExecutor - Executor to use for offloading close signals.

Method Detail

addIfAbsent

public boolean addIfAbsent(io.netty.channel.Channel channel)

Add a Channel to this ChannelSet, if it is not already present. Channel.id() is used to check uniqueness.

Parameters:

channel - The Channel to add.

Returns:

true if the channel was added successfully, false otherwise.

closeAsync

public Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A CompletableSource that is notified once the close is complete.

closeAsyncGracefully

public 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 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.