Package io.grpc.xds

Class XdsServerBuilder

java.lang.Object

io.grpc.ServerBuilder<T>

io.grpc.ForwardingServerBuilder<XdsServerBuilder>

io.grpc.xds.XdsServerBuilder

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/7514")
public final class XdsServerBuilder
extends ForwardingServerBuilder<XdsServerBuilder>

A version of ServerBuilder to create xDS managed servers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	XdsServerBuilder.XdsServingStatusListener	Applications can register this listener to receive "serving" and "not serving" states of the server using xdsServingStatusListener(XdsServingStatusListener).

Method Summary

Modifier and Type	Method	Description
Server	build()	Returns the Server built by the delegate by default.
XdsServerBuilder	childChannelConfigurator(ChannelConfigurator channelConfigurator)	Sets the configurator that will be stored in the server built by this builder.
protected ServerBuilder<?>	delegate()	Returns the delegated ServerBuilder.
XdsServerBuilder	drainGraceTime(long drainGraceTime, TimeUnit drainGraceTimeUnit)	Sets the grace time when draining connections with outdated configuration.
static XdsServerBuilder	forAddress(SocketAddress address, ServerCredentials serverCredentials)	Creates a gRPC server builder for the given address.
static ServerBuilder<?>	forPort(int port)
static XdsServerBuilder	forPort(int port, ServerCredentials serverCredentials)	Creates a gRPC server builder for the given port.
XdsServerBuilder	ldsResourceNameResolver(Function<String,String> ldsResourceNameResolver)	Provides a function that takes the listening address and returns the LDS resource name.
XdsServerBuilder	overrideBootstrapForTest(Map<String,?> bootstrapOverride)	Allows providing bootstrap override, useful for testing.
ServerBuilder<?>	transportBuilder()	Returns the delegate NettyServerBuilder to allow experimental level transport-specific configuration.
XdsServerBuilder	xdsServingStatusListener(XdsServerBuilder.XdsServingStatusListener xdsServingStatusListener)	Set the XdsServerBuilder.XdsServingStatusListener to receive "serving" and "not serving" states.

Methods inherited from class io.grpc.ForwardingServerBuilder

addMetricSink, addService, addService, addStreamTracerFactory, addTransportFilter, callExecutor, compressorRegistry, decompressorRegistry, directExecutor, executor, fallbackHandlerRegistry, handshakeTimeout, intercept, keepAliveTime, keepAliveTimeout, maxConnectionAge, maxConnectionAgeGrace, maxConnectionIdle, maxInboundMessageSize, maxInboundMetadataSize, permitKeepAliveTime, permitKeepAliveWithoutCalls, setBinaryLog, toString, useTransportSecurity, useTransportSecurity

Methods inherited from class io.grpc.ServerBuilder

addServices

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

delegate

@Internal
protected ServerBuilder<?> delegate()

Description copied from class: ForwardingServerBuilder

Returns the delegated ServerBuilder.

Specified by:

delegate in class ForwardingServerBuilder<XdsServerBuilder>

xdsServingStatusListener

public XdsServerBuilder xdsServingStatusListener(XdsServerBuilder.XdsServingStatusListener xdsServingStatusListener)

Set the XdsServerBuilder.XdsServingStatusListener to receive "serving" and "not serving" states.

drainGraceTime

public XdsServerBuilder drainGraceTime(long drainGraceTime,
                                       TimeUnit drainGraceTimeUnit)

Sets the grace time when draining connections with outdated configuration. When an xDS config update changes connection configuration, pre-existing connections stop accepting new RPCs to be replaced by new connections. RPCs on those pre-existing connections have the grace time to complete. RPCs that do not complete in time will be cancelled, allowing the connection to terminate. Long.MAX_VALUE nano seconds or an unreasonably large value are considered infinite. The default is 10 minutes.

childChannelConfigurator

public XdsServerBuilder childChannelConfigurator(ChannelConfigurator channelConfigurator)

Sets the configurator that will be stored in the server built by this builder.

This configurator will subsequently be used to configure any child channels created by that server.

Parameters:

channelConfigurator - the configurator to store in the channel.

Returns:

this

forPort

public static ServerBuilder<?> forPort(int port)

forPort

public static XdsServerBuilder forPort(int port,
                                       ServerCredentials serverCredentials)

Creates a gRPC server builder for the given port.

forAddress

public static XdsServerBuilder forAddress(SocketAddress address,
                                          ServerCredentials serverCredentials)

Creates a gRPC server builder for the given address.

build

public Server build()

Description copied from class: ForwardingServerBuilder

Returns the Server built by the delegate by default. Overriding method can return different value.

Overrides:

build in class ForwardingServerBuilder<XdsServerBuilder>

Returns:

a new Server

ldsResourceNameResolver

public XdsServerBuilder ldsResourceNameResolver(Function<String,String> ldsResourceNameResolver)

Provides a function that takes the listening address and returns the LDS resource name. When provided, this overrides the server_listener_resource_name_template in the bootstrap.

overrideBootstrapForTest

public XdsServerBuilder overrideBootstrapForTest(Map<String,?> bootstrapOverride)

Allows providing bootstrap override, useful for testing.

transportBuilder

public ServerBuilder<?> transportBuilder()

Returns the delegate NettyServerBuilder to allow experimental level transport-specific configuration. Note this API will always be experimental.