io.servicetalk.concurrent.api

Interface CompositeCloseable

All Superinterfaces:

AsyncCloseable, AutoCloseable, GracefulAutoCloseable

public interface CompositeCloseable
extends AsyncCloseable, GracefulAutoCloseable

A AsyncCloseable and Closeable that allows for adding new AsyncCloseables till it is closed.

Method Summary

Modifier and Type	Method and Description
<T extends AsyncCloseable> T	append(T closeable) Appends the passed AsyncCloseable with this CompositeCloseable such that when this CompositeCloseable is closed, all of the previously registered AsyncCloseables are closed too.
CompositeCloseable	appendAll(AsyncCloseable... asyncCloseables) Appends all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too.
CompositeCloseable	appendAll(Iterable<? extends AsyncCloseable> asyncCloseables) Appends all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too.
void	close() Closes all contained AsyncCloseables and awaits termination of all of them.
Completable	closeAsync() Closes all contained AsyncCloseables.
<T extends AsyncCloseable> T	merge(T closeable) Merges the passed AsyncCloseable with this CompositeCloseable such that when this CompositeCloseable is closed, all of the previously registered AsyncCloseables are closed too.
CompositeCloseable	mergeAll(AsyncCloseable... asyncCloseables) Merges all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too.
CompositeCloseable	mergeAll(Iterable<? extends AsyncCloseable> asyncCloseables) Merges all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too.
<T extends AsyncCloseable> T	prepend(T closeable) Prepends the passed AsyncCloseable with this CompositeCloseable such that when this CompositeCloseable is closed, all of the previously registered AsyncCloseables are closed too.
CompositeCloseable	prependAll(AsyncCloseable... asyncCloseables) Prepends all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too.
CompositeCloseable	prependAll(Iterable<? extends AsyncCloseable> asyncCloseables) Prepends all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too.

Methods inherited from interface AsyncCloseable

closeAsyncGracefully

Methods inherited from interface GracefulAutoCloseable

closeGracefully

Method Detail

merge

<T extends AsyncCloseable> T merge(T closeable)

Merges the passed AsyncCloseable with this CompositeCloseable such that when this CompositeCloseable is closed, all of the previously registered AsyncCloseables are closed too. This method subscribes to the passed in AsyncCloseable and the current composite set at the same time. If an order of closure is required, then use append(AsyncCloseable) or prepend(AsyncCloseable).

Type Parameters:

T - the type of AsyncCloseable to be merged

Parameters:

closeable - AsyncCloseable that is closed when this CompositeCloseable is closed.

Returns:

T

mergeAll

CompositeCloseable mergeAll(AsyncCloseable... asyncCloseables)

Merges all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too. This method subscribes to all passed in AsyncCloseables and the current composite set at the same time. If an order of closure is required, then use appendAll(AsyncCloseable...) or prependAll(AsyncCloseable...).

Parameters:

asyncCloseables - All AsyncCloseables that are closed when this CompositeCloseable is closed.

Returns:

this.

mergeAll

CompositeCloseable mergeAll(Iterable<? extends AsyncCloseable> asyncCloseables)

Merges all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too. This method subscribes to all passed in AsyncCloseables and the current composite set at the same time. If an order of closure is required, then use appendAll(AsyncCloseable...) or prependAll(AsyncCloseable...).

Parameters:

asyncCloseables - All AsyncCloseables that are closed when this CompositeCloseable is closed.

Returns:

this.

append

<T extends AsyncCloseable> T append(T closeable)

Appends the passed AsyncCloseable with this CompositeCloseable such that when this CompositeCloseable is closed, all of the previously registered AsyncCloseables are closed too. This method subscribes to the passed in AsyncCloseable and the current composite set in order. If an order of closure is not required, then use merge(AsyncCloseable).

Type Parameters:

T - the type of AsyncCloseable to be appended

Parameters:

closeable - AsyncCloseable that is closed when this CompositeCloseable is closed.

Returns:

T.

appendAll

CompositeCloseable appendAll(AsyncCloseable... asyncCloseables)

Appends all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too. This method subscribes to all passed in AsyncCloseables and the current composite set in the order they are passed to this method. If an order of closure is not required, then use mergeAll(AsyncCloseable...).

Parameters:

asyncCloseables - All AsyncCloseables that are closed when this CompositeCloseable is closed.

Returns:

this.

appendAll

CompositeCloseable appendAll(Iterable<? extends AsyncCloseable> asyncCloseables)

Appends all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too. This method subscribes to all passed in AsyncCloseables and the current composite set in the order they are passed to this method. If an order of closure is not required, then use mergeAll(AsyncCloseable...).

Parameters:

asyncCloseables - All AsyncCloseables that are closed when this CompositeCloseable is closed.

Returns:

this.

prepend

<T extends AsyncCloseable> T prepend(T closeable)

Prepends the passed AsyncCloseable with this CompositeCloseable such that when this CompositeCloseable is closed, all of the previously registered AsyncCloseables are closed too. This method subscribes to the passed in AsyncCloseable and the current composite set in reverse order. If an order of closure is not required, then use merge(AsyncCloseable).

Type Parameters:

T - the type of AsyncCloseable to be prepended

Parameters:

closeable - AsyncCloseable that is closed when this CompositeCloseable is closed.

Returns:

T.

prependAll

CompositeCloseable prependAll(AsyncCloseable... asyncCloseables)

Prepends all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too. This method subscribes to all passed in AsyncCloseables and the current composite set in the reverse order they are passed to this method. If an order of closure is not required, then use mergeAll(AsyncCloseable...).

Parameters:

asyncCloseables - All AsyncCloseables that are closed when this CompositeCloseable is closed.

Returns:

this.

prependAll

CompositeCloseable prependAll(Iterable<? extends AsyncCloseable> asyncCloseables)

Prepends all the passed AsyncCloseables with this CompositeCloseable such that when this CompositeCloseable is closed, all of these AsyncCloseables are closed too. This method subscribes to all passed in AsyncCloseables and the current composite set in the reverse order they are passed to this method. If an order of closure is not required, then use mergeAll(AsyncCloseable...).

Parameters:

asyncCloseables - All AsyncCloseables that are closed when this CompositeCloseable is closed.

Returns:

this.

closeAsync

Completable closeAsync()

Closes all contained AsyncCloseables. If any of the contained AsyncCloseables terminated with a failure, the returned Completable terminates with a failure only after all the contained AsyncCloseables have terminated.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

the Completable that is notified once the close is complete.

close

void close()
    throws Exception

Closes all contained AsyncCloseables and awaits termination of all of them. If any of the contained AsyncCloseables terminated with a failure, this method terminates with an Exception only after all the contained AsyncCloseables have terminated.

Specified by:

close in interface AutoCloseable

Throws:

Exception - If any of the contained AsyncCloseables terminate with a failure.