Skip to content

Commit 069ea6f

Browse files
committed
docs: Improve Javadoc for HostAndPortMapper (#4112)
1 parent 84ab6fd commit 069ea6f

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
package redis.clients.jedis;
22

3+
/**
4+
* An interface for mapping Redis node addresses.
5+
* <p>
6+
* It is used to translate an advertised server address to one that is reachable by the client,
7+
* especially in network topologies involving NAT or containerization.
8+
*/
9+
@FunctionalInterface
310
public interface HostAndPortMapper {
411

12+
/**
13+
* @param hap The original address from the server.
14+
* @return The translated, reachable address.
15+
*/
516
HostAndPort getHostAndPort(HostAndPort hap);
617
}

0 commit comments

Comments
 (0)