Package io.servicetalk.concurrent.api

Class DelegatingAsyncCloseable<T extends AsyncCloseable>

java.lang.Object

io.servicetalk.concurrent.api.DelegatingAsyncCloseable<T>

Type Parameters:

T - The type of AsyncCloseable to delegate to.

All Implemented Interfaces:

AsyncCloseable

Direct Known Subclasses:

DelegatingListenableAsyncCloseable

public class DelegatingAsyncCloseable<T extends AsyncCloseable>
extends Object
implements AsyncCloseable

AsyncCloseable that delegates all calls to another AsyncCloseable.

Constructor Summary

Constructors

Constructor	Description
DelegatingAsyncCloseable(T delegate)	New instance.

Method Summary

Modifier and Type	Method	Description
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 T	delegate()	Get the DelegatingAsyncCloseable subtype of AsyncCloseable that this class delegates to.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingAsyncCloseable

public DelegatingAsyncCloseable(T delegate)

New instance.

Parameters:

delegate - DelegatingAsyncCloseable subtype of AsyncCloseable to delegate all calls to.

Method Details

delegate

protected T delegate()

Get the DelegatingAsyncCloseable subtype of AsyncCloseable that this class delegates to.

Returns:

the DelegatingAsyncCloseable subtype of AsyncCloseable that this class delegates to.

closeAsync

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

toString

public String toString()

Overrides:

toString in class Object