com.datastax.oss.driver.api.core

Interface AsyncAutoCloseable

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

CqlSession, Session

public interface AsyncAutoCloseable
extends AutoCloseable

An object that can be closed in an asynchronous, non-blocking manner.

For convenience, this extends the JDK's AutoCloseable in order to be usable in try-with-resource blocks (in that case, the blocking close() will be used).

Method Summary

Modifier and Type	Method and Description
default void	close()
CompletionStage<Void>	closeAsync() Initiates an orderly shutdown: no new requests are accepted, but all pending requests are allowed to complete normally.
CompletionStage<Void>	closeFuture() Returns a stage that will complete when close() or forceCloseAsync() is called, and the shutdown sequence completes.
CompletionStage<Void>	forceCloseAsync() Initiates a forced shutdown of this instance: no new requests are accepted, and all pending requests will complete with an exception.
default boolean	isClosed() Whether shutdown has completed.

Method Detail

closeFuture

@NonNull
CompletionStage<Void> closeFuture()

Returns a stage that will complete when close() or forceCloseAsync() is called, and the shutdown sequence completes.

isClosed

default boolean isClosed()

Whether shutdown has completed.

This is a shortcut for closeFuture().toCompletableFuture().isDone().

closeAsync

@NonNull
CompletionStage<Void> closeAsync()

Initiates an orderly shutdown: no new requests are accepted, but all pending requests are allowed to complete normally.

Returns:

a stage that will complete when the shutdown sequence is complete. Multiple calls to this method or forceCloseAsync() always return the same instance.

forceCloseAsync

@NonNull
CompletionStage<Void> forceCloseAsync()

Initiates a forced shutdown of this instance: no new requests are accepted, and all pending requests will complete with an exception.

Returns:

a stage that will complete when the shutdown sequence is complete. Multiple calls to this method or close() always return the same instance.

close

default void close()

This method is implemented by calling closeAsync() and blocking on the result. This should not be called on a driver thread.

Specified by:

close in interface AutoCloseable