Skip to content

docs: Update Driver#close() and Driver#closeAsync() documentation #1634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 15, 2025
Merged

docs: Update Driver#close() and Driver#closeAsync() documentation #1634

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions driver/src/main/java/org/neo4j/driver/Driver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,9 +335,9 @@ default AsyncSession asyncSession(SessionConfig sessionConfig) {
* <p>
* This operation works the same way as {@link #closeAsync()} but blocks until all resources are closed.
* <p>
* Please note that this method is intended for graceful shutdown only and expects that all driver interactions have
* either been finished or no longer awaited for. Pending driver API calls may not be completed after this method is
* invoked.
* Since this method is intended for graceful shutdown only, it is strongly recommended to finish interaction with
* all driver resources (like sessions, transactions, results, etc.) before invoking this method. Not doing this may
* result in unspecified behaviour, including leaving driver execution unfinished indefinitely.
*/
@Override
void close();
Expand All @@ -348,9 +348,9 @@ default AsyncSession asyncSession(SessionConfig sessionConfig) {
* This operation is asynchronous and returns a {@link CompletionStage}. This stage is completed with
* {@code null} when all resources are closed. It is completed exceptionally if termination fails.
* <p>
* Please note that this method is intended for graceful shutdown only and expects that all driver interactions have
* either been finished or no longer awaited for. Pending driver API calls may not be completed after this method is
* invoked.
* Since this method is intended for graceful shutdown only, it is strongly recommended to finish interaction with
* all driver resources (like sessions, transactions, results, etc.) before invoking this method. Not doing this may
* result in unspecified behaviour, including leaving driver execution unfinished indefinitely.
*
* @return a {@link CompletionStage completion stage} that represents the asynchronous close.
*/
Expand Down