io.servicetalk.concurrent.api

Class AsyncCloseables

Object

AsyncCloseables

public final class AsyncCloseables
extends Object

A utility class to create AsyncCloseables.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AsyncCloseables.CloseableResource A resource that can be converted to an AsyncCloseable.

Method Summary

Modifier and Type	Method and Description
static Completable	closeAsyncGracefully(AsyncCloseable closable, long timeout, TimeUnit timeoutUnit) Invokes AsyncCloseable.closeAsyncGracefully() on the closable, applies a timeout, and if the timeout fires forces a call to AsyncCloseable.closeAsync().
static ListenableAsyncCloseable	emptyAsyncCloseable() Creates an empty ListenableAsyncCloseable that does nothing when AsyncCloseable.closeAsync() apart from completing the ListenableAsyncCloseable.onClose().
static CompositeCloseable	newCompositeCloseable() Creates a new CompositeCloseable.
static ListenableAsyncCloseable	toAsyncCloseable(AsyncCloseables.CloseableResource closeableResource) Creates a new ListenableAsyncCloseable which uses the passed Supplier to get the implementation of close.
static ListenableAsyncCloseable	toListenableAsyncCloseable(AsyncCloseable asyncCloseable) Wraps the passed AsyncCloseable and creates a new ListenableAsyncCloseable.
static ListenableAsyncCloseable	toListenableAsyncCloseable(AsyncCloseable asyncCloseable, Function<Completable,Completable> onCloseDecorator) Wraps the passed AsyncCloseable and creates a new ListenableAsyncCloseable.

Methods inherited from class Object

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

Method Detail

closeAsyncGracefully

public static Completable closeAsyncGracefully(AsyncCloseable closable,
                                               long timeout,
                                               TimeUnit timeoutUnit)

Invokes AsyncCloseable.closeAsyncGracefully() on the closable, applies a timeout, and if the timeout fires forces a call to AsyncCloseable.closeAsync().

Parameters:

closable - The AsyncCloseable to initiate AsyncCloseable.closeAsyncGracefully() on.

timeout - The timeout duration to wait for AsyncCloseable.closeAsyncGracefully() to complete.

timeoutUnit - The time unit applied to timeout.

Returns:

A Completable that is notified once the close is complete.

emptyAsyncCloseable

public static ListenableAsyncCloseable emptyAsyncCloseable()

Creates an empty ListenableAsyncCloseable that does nothing when AsyncCloseable.closeAsync() apart from completing the ListenableAsyncCloseable.onClose().

Returns:

A new ListenableAsyncCloseable.

toListenableAsyncCloseable

public static ListenableAsyncCloseable toListenableAsyncCloseable(AsyncCloseable asyncCloseable)

Wraps the passed AsyncCloseable and creates a new ListenableAsyncCloseable. This method owns the passed AsyncCloseable after this method returns and hence it should not be used by the caller after this method returns.

Parameters:

asyncCloseable - AsyncCloseable to convert to ListenableAsyncCloseable.

Returns:

A new ListenableAsyncCloseable.

toListenableAsyncCloseable

public static ListenableAsyncCloseable toListenableAsyncCloseable(AsyncCloseable asyncCloseable,
                                                                  Function<Completable,Completable> onCloseDecorator)

Wraps the passed AsyncCloseable and creates a new ListenableAsyncCloseable. This method owns the passed AsyncCloseable after this method returns and hence it should not be used by the caller after this method returns.

Parameters:

asyncCloseable - AsyncCloseable to convert to ListenableAsyncCloseable.

onCloseDecorator - Function that can decorate the Completable returned from the returned ListenableAsyncCloseable.onClose().

Returns:

A new ListenableAsyncCloseable.

toAsyncCloseable

public static ListenableAsyncCloseable toAsyncCloseable(AsyncCloseables.CloseableResource closeableResource)

Creates a new ListenableAsyncCloseable which uses the passed Supplier to get the implementation of close.

Parameters:

closeableResource - AsyncCloseables.CloseableResource that is to be wrapped into a ListenableAsyncCloseable. AsyncCloseables.CloseableResource.doClose(boolean) will be called when the returned ListenableAsyncCloseable is closed or gracefully closed for the first time.

Returns:

A new ListenableAsyncCloseable.

newCompositeCloseable

public static CompositeCloseable newCompositeCloseable()

Creates a new CompositeCloseable.

Returns:

A new CompositeCloseable.