io.servicetalk.concurrent.api

Interface AsyncCloseable

All Known Subinterfaces:

CompositeCloseable, Executor, ListenableAsyncCloseable

All Known Implementing Classes:

DelegatingExecutor

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface AsyncCloseable

Used to close/shutdown a resource.

Method Summary

Modifier and Type	Method and Description
Completable	closeAsync() Used to close/shutdown a resource.
default Completable	closeAsyncGracefully() Used to close/shutdown a resource, similar to closeAsync(), but attempts to cleanup state before abruptly closing.

Method Detail

closeAsync

Completable closeAsync()

Used to close/shutdown a resource.

Returns:

A CompletableSource that is notified once the close is complete.

closeAsyncGracefully

default Completable closeAsyncGracefully()

Used to close/shutdown a resource, similar to 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 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 closeAsync().

Returns:

A Completable that is notified once the close is complete.