grpc
/
grpc-java
mirror of https://github.com/grpc/grpc-java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

api: ManagedChannelBuilder note about ipv6 scope id JDK bug. (#10503) 

Adds a note on how to avoid a JDK bug by converting an ipv6 scope ID to
its numeric form.
This commit is contained in:
Terry Wilson 2023-08-17 18:05:15 -07:00 committed by GitHub
parent 97f4f8687c
commit d987fb10aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
api/src/main/java/io/grpc/ManagedChannelBuilder.java
View File

@ -32,6 +32,11 @@ public abstract class ManagedChannelBuilder<T extends ManagedChannelBuilder<T>>
/** /**
* Creates a channel with the target's address and port number. * Creates a channel with the target's address and port number.
* *
* <p>Note that there is an open JDK bug on {@link java.net.URI} class parsing an ipv6 scope ID:
* bugs.openjdk.org/browse/JDK-8199396. This method is exposed to this bug. If you experience an
* issue, a work-around is to convert the scope ID to its numeric form (e.g. by using
* Inet6Address.getScopeId()) before calling this method.
*
* @see #forTarget(String) * @see #forTarget(String)
* @since 1.0.0 * @since 1.0.0
*/ */
@ -70,6 +75,11 @@ public abstract class ManagedChannelBuilder<T extends ManagedChannelBuilder<T>>
* <li>{@code "[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443"}</li> * <li>{@code "[2001:db8:85a3:8d3:1319:8a2e:370:7348]:443"}</li>
* </ul> * </ul>
* *
* <p>Note that there is an open JDK bug on {@link java.net.URI} class parsing an ipv6 scope ID:
* bugs.openjdk.org/browse/JDK-8199396. This method is exposed to this bug. If you experience an
* issue, a work-around is to convert the scope ID to its numeric form (e.g. by using
* Inet6Address.getScopeId()) before calling this method.
*
* @since 1.0.0 * @since 1.0.0
*/ */
public static ManagedChannelBuilder<?> forTarget(String target) { public static ManagedChannelBuilder<?> forTarget(String target) {