Skip to content

Commit 546cef1

Browse files
author
Zhen Li
committed
Improve the javadoc for resolver API
To suggest user defined resolver func to shuffle addresses order before returning.
1 parent 3483c4e commit 546cef1

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

driver/src/main/java/org/neo4j/driver/net/ServerAddressResolver.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
*/
1919
package org.neo4j.driver.net;
2020

21+
import java.util.LinkedHashSet;
2122
import java.util.Set;
2223

2324
/**
@@ -28,6 +29,9 @@ public interface ServerAddressResolver
2829
{
2930
/**
3031
* Resolve the given address to a set of other addresses.
32+
* It is highly recommended to shuffle the addresses returned to prevent the driver from
33+
* always retrying servers in a specific order.
34+
* Considering returning a {@link LinkedHashSet} to reserve the iteration order of a set.
3135
* Exceptions thrown by this method will be logged and driver will continue using the original address.
3236
*
3337
* @param address the address to resolve.

0 commit comments

Comments
 (0)