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

xds: add/enhance Javadoc comments for XdsServerBuilder. (#8007)

This commit is contained in:
sanjaypujare 2021-03-23 10:53:21 -07:00 committed by GitHub
parent 931d95d3f3
commit c4dec7517f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
xds/src/main/java/io/grpc/xds/XdsServerBuilder.java
View File

@ -48,8 +48,7 @@ import java.util.concurrent.atomic.AtomicBoolean;
import javax.annotation.Nullable; import javax.annotation.Nullable;
/** /**
* A version of {@link ServerBuilder} to create xDS managed servers that will use SDS to set up SSL * A version of {@link ServerBuilder} to create xDS managed servers.
* with peers. Note, this is not ready to use yet.
*/ */
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/7514") @ExperimentalApi("https://github.com/grpc/grpc-java/issues/7514")
public final class XdsServerBuilder extends ForwardingServerBuilder<XdsServerBuilder> { public final class XdsServerBuilder extends ForwardingServerBuilder<XdsServerBuilder> {
@ -71,7 +70,7 @@ public final class XdsServerBuilder extends ForwardingServerBuilder<XdsServerBui
return delegate; return delegate;
} }
/** Set the {@link XdsServingStatusListener}. */ /** Set the {@link XdsServingStatusListener} to receive "serving" and "not serving" states. */
public XdsServerBuilder xdsServingStatusListener( public XdsServerBuilder xdsServingStatusListener(
XdsServingStatusListener xdsServingStatusListener) { XdsServingStatusListener xdsServingStatusListener) {
this.xdsServingStatusListener = this.xdsServingStatusListener =
@ -111,11 +110,18 @@ public final class XdsServerBuilder extends ForwardingServerBuilder<XdsServerBui
return new ServerWrapperForXds(delegate, xdsClient, xdsServingStatusListener); return new ServerWrapperForXds(delegate, xdsClient, xdsServingStatusListener);
} }
/**
* Returns the delegate {@link NettyServerBuilder} to allow experimental level
* transport-specific configuration. Note this API will always be experimental.
*/
public ServerBuilder<?> transportBuilder() { public ServerBuilder<?> transportBuilder() {
return delegate; return delegate;
} }
/** Watcher to receive error notifications from xDS control plane during {@code start()}. */ /**
* Applications can register this listener to receive "serving" and "not serving" states of
* the server using {@link #xdsServingStatusListener(XdsServingStatusListener)}.
*/
public interface XdsServingStatusListener { public interface XdsServingStatusListener {
/** Callback invoked when server begins serving. */ /** Callback invoked when server begins serving. */
@ -127,7 +133,7 @@ public final class XdsServerBuilder extends ForwardingServerBuilder<XdsServerBui
void onNotServing(Throwable throwable); void onNotServing(Throwable throwable);
} }
/** Default implementation that logs at WARNING level. */ /** Default implementation of {@link XdsServingStatusListener} that logs at WARNING level. */
private static class DefaultListener implements XdsServingStatusListener { private static class DefaultListener implements XdsServingStatusListener {
XdsLogger xdsLogger; XdsLogger xdsLogger;
boolean notServing; boolean notServing;