Class ServerImplBuilder

java.lang.Object

io.grpc.ServerBuilder<ServerImplBuilder>

io.grpc.internal.ServerImplBuilder

public final class ServerImplBuilder
extends ServerBuilder<ServerImplBuilder>

Default builder for Server instances, for usage in Transport implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ServerImplBuilder.ClientTransportServersBuilder	An interface to provide to provide transport specific information for the server.
private static final class	ServerImplBuilder.DefaultFallbackRegistry

Field Summary

Fields

Modifier and Type	Field	Description
(package private) BinaryLog	binlog
(package private) CallTracer.Factory	callTracerFactory
(package private) InternalChannelz	channelz
private final ServerImplBuilder.ClientTransportServersBuilder	clientTransportServersBuilder
(package private) CompressorRegistry	compressorRegistry
(package private) DecompressorRegistry	decompressorRegistry
private static final CompressorRegistry	DEFAULT_COMPRESSOR_REGISTRY
private static final DecompressorRegistry	DEFAULT_DECOMPRESSOR_REGISTRY
private static final ObjectPool<? extends Executor>	DEFAULT_EXECUTOR_POOL
private static final HandlerRegistry	DEFAULT_FALLBACK_REGISTRY
private static final long	DEFAULT_HANDSHAKE_TIMEOUT_MILLIS
(package private) ObjectPool<? extends Executor>	executorPool
(package private) ServerCallExecutorSupplier	executorSupplier
(package private) HandlerRegistry	fallbackRegistry
(package private) long	handshakeTimeoutMillis
(package private) final List<ServerInterceptor>	interceptors
private static final Logger	log
private boolean	recordFinishedRpcs
private boolean	recordRealTimeMetrics
private boolean	recordStartedRpcs
(package private) final InternalHandlerRegistry.Builder	registryBuilder
private boolean	statsEnabled
private final List<ServerStreamTracer.Factory>	streamTracerFactories
(package private) Deadline.Ticker	ticker
private boolean	tracingEnabled
(package private) final List<ServerTransportFilter>	transportFilters

Constructor Summary

Constructors

Constructor	Description
ServerImplBuilder(ServerImplBuilder.ClientTransportServersBuilder clientTransportServersBuilder)	Creates a new server builder with given transport servers provider.

Method Summary

Modifier and Type	Method	Description
ServerImplBuilder	addService(BindableService bindableService)	Adds a service implementation to the handler registry.
ServerImplBuilder	addService(ServerServiceDefinition service)	Adds a service implementation to the handler registry.
ServerImplBuilder	addStreamTracerFactory(ServerStreamTracer.Factory factory)	Adds a ServerStreamTracer.Factory to measure server-side traffic.
ServerImplBuilder	addTransportFilter(ServerTransportFilter filter)	Adds a ServerTransportFilter.
Server	build()	Builds a server using the given parameters.
ServerImplBuilder	callExecutor(ServerCallExecutorSupplier executorSupplier)	Allows for defining a way to provide a custom executor to handle the server call.
ServerImplBuilder	compressorRegistry(CompressorRegistry registry)	Set the compression registry for use in the channel.
ServerImplBuilder	decompressorRegistry(DecompressorRegistry registry)	Set the decompression registry for use in the channel.
ServerImplBuilder	directExecutor()	Execute application code directly in the transport thread.
ServerImplBuilder	executor(Executor executor)	Provides a custom executor.
ServerImplBuilder	fallbackHandlerRegistry(HandlerRegistry registry)	Sets a fallback handler registry that will be looked up in if a method is not found in the primary registry.
static ServerBuilder<?>	forPort(int port)
InternalChannelz	getChannelz()
ObjectPool<? extends Executor>	getExecutorPool()	Returns the internal ExecutorPool for offloading tasks.
(package private) List<? extends ServerStreamTracer.Factory>	getTracerFactories()
ServerImplBuilder	handshakeTimeout(long timeout, TimeUnit unit)	Sets the permitted time for new connections to complete negotiation handshakes before being killed.
ServerImplBuilder	intercept(ServerInterceptor interceptor)	Adds a ServerInterceptor that is run for all services on the server.
ServerImplBuilder	setBinaryLog(BinaryLog binaryLog)	Sets the BinaryLog object that this server should log to.
void	setDeadlineTicker(Deadline.Ticker ticker)	Sets a custom deadline ticker.
void	setStatsEnabled(boolean value)	Disable or enable stats features.
void	setStatsRecordFinishedRpcs(boolean value)	Disable or enable stats recording for RPC completions.
void	setStatsRecordRealTimeMetrics(boolean value)	Disable or enable real-time metrics recording.
void	setStatsRecordStartedRpcs(boolean value)	Disable or enable stats recording for RPC upstarts.
void	setTracingEnabled(boolean value)	Disable or enable tracing features.
ServerImplBuilder	useTransportSecurity(File certChain, File privateKey)	Makes the server use TLS.

Methods inherited from class ServerBuilder

addServices, keepAliveTime, keepAliveTimeout, maxConnectionAge, maxConnectionAgeGrace, maxConnectionIdle, maxInboundMessageSize, maxInboundMetadataSize, permitKeepAliveTime, permitKeepAliveWithoutCalls, useTransportSecurity

Methods inherited from class Object

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

Field Details

log

private static final Logger log

DEFAULT_EXECUTOR_POOL

private static final ObjectPool<? extends Executor> DEFAULT_EXECUTOR_POOL

DEFAULT_FALLBACK_REGISTRY

private static final HandlerRegistry DEFAULT_FALLBACK_REGISTRY

DEFAULT_DECOMPRESSOR_REGISTRY

private static final DecompressorRegistry DEFAULT_DECOMPRESSOR_REGISTRY

DEFAULT_COMPRESSOR_REGISTRY

private static final CompressorRegistry DEFAULT_COMPRESSOR_REGISTRY

DEFAULT_HANDSHAKE_TIMEOUT_MILLIS

private static final long DEFAULT_HANDSHAKE_TIMEOUT_MILLIS

registryBuilder

final InternalHandlerRegistry.Builder registryBuilder

transportFilters

final List<ServerTransportFilter> transportFilters

interceptors

final List<ServerInterceptor> interceptors

streamTracerFactories

private final List<ServerStreamTracer.Factory> streamTracerFactories

clientTransportServersBuilder

private final ServerImplBuilder.ClientTransportServersBuilder clientTransportServersBuilder

fallbackRegistry

HandlerRegistry fallbackRegistry

executorPool

ObjectPool<? extends Executor> executorPool

decompressorRegistry

DecompressorRegistry decompressorRegistry

compressorRegistry

CompressorRegistry compressorRegistry

handshakeTimeoutMillis

long handshakeTimeoutMillis

ticker

Deadline.Ticker ticker

statsEnabled

private boolean statsEnabled

recordStartedRpcs

private boolean recordStartedRpcs

recordFinishedRpcs

private boolean recordFinishedRpcs

recordRealTimeMetrics

private boolean recordRealTimeMetrics

tracingEnabled

private boolean tracingEnabled

binlog

@Nullable
BinaryLog binlog

channelz

InternalChannelz channelz

callTracerFactory

CallTracer.Factory callTracerFactory

executorSupplier

@Nullable
ServerCallExecutorSupplier executorSupplier

Constructor Details

ServerImplBuilder

public ServerImplBuilder(ServerImplBuilder.ClientTransportServersBuilder clientTransportServersBuilder)

Creates a new server builder with given transport servers provider.

Method Details

forPort

public static ServerBuilder<?> forPort(int port)

directExecutor

public ServerImplBuilder directExecutor()

Description copied from class: ServerBuilder

Execute application code directly in the transport thread.

Depending on the underlying transport, using a direct executor may lead to substantial performance improvements. However, it also requires the application to not block under any circumstances.

Calling this method is semantically equivalent to calling ServerBuilder.executor(Executor) and passing in a direct executor. However, this is the preferred way as it may allow the transport to perform special optimizations.

Specified by:

directExecutor in class ServerBuilder<ServerImplBuilder>

Returns:

this

executor

public ServerImplBuilder executor(@Nullable
 Executor executor)

Description copied from class: ServerBuilder

Provides a custom executor.

It's an optional parameter. If the user has not provided an executor when the server is built, the builder will use a static cached thread pool.

The server won't take ownership of the given executor. It's caller's responsibility to shut down the executor when it's desired.

Specified by:

executor in class ServerBuilder<ServerImplBuilder>

Returns:

this

callExecutor

public ServerImplBuilder callExecutor(ServerCallExecutorSupplier executorSupplier)

Description copied from class: ServerBuilder

Allows for defining a way to provide a custom executor to handle the server call. This executor is the result of calling ServerCallExecutorSupplier.getExecutor(ServerCall, Metadata) per RPC.

It's an optional parameter. If it is provided, the ServerBuilder.executor(Executor) would still run necessary tasks before the ServerCallExecutorSupplier is ready to be called, then it switches over. But if calling ServerCallExecutorSupplier returns null, the server call is still handled by the default ServerBuilder.executor(Executor) as a fallback.

Overrides:

callExecutor in class ServerBuilder<ServerImplBuilder>

Parameters:

executorSupplier - the server call executor provider

Returns:

this

addService

public ServerImplBuilder addService(ServerServiceDefinition service)

Description copied from class: ServerBuilder

Adds a service implementation to the handler registry.

Specified by:

addService in class ServerBuilder<ServerImplBuilder>

Parameters:

service - ServerServiceDefinition object

Returns:

this

addService

public ServerImplBuilder addService(BindableService bindableService)

Description copied from class: ServerBuilder

Adds a service implementation to the handler registry.

Specified by:

addService in class ServerBuilder<ServerImplBuilder>

Parameters:

bindableService - BindableService object

Returns:

this

addTransportFilter

public ServerImplBuilder addTransportFilter(ServerTransportFilter filter)

Description copied from class: ServerBuilder

Adds a ServerTransportFilter. The order of filters being added is the order they will be executed.

Overrides:

addTransportFilter in class ServerBuilder<ServerImplBuilder>

Returns:

this

intercept

public ServerImplBuilder intercept(ServerInterceptor interceptor)

Description copied from class: ServerBuilder

Adds a ServerInterceptor that is run for all services on the server. Interceptors added through this method always run before per-service interceptors added through ServerInterceptors. Interceptors run in the reverse order in which they are added, just as with consecutive calls to ServerInterceptors.intercept().

Overrides:

intercept in class ServerBuilder<ServerImplBuilder>

Parameters:

interceptor - the all-service interceptor

Returns:

this

addStreamTracerFactory

public ServerImplBuilder addStreamTracerFactory(ServerStreamTracer.Factory factory)

Description copied from class: ServerBuilder

Adds a ServerStreamTracer.Factory to measure server-side traffic. The order of factories being added is the order they will be executed.

Overrides:

addStreamTracerFactory in class ServerBuilder<ServerImplBuilder>

Returns:

this

fallbackHandlerRegistry

public ServerImplBuilder fallbackHandlerRegistry(@Nullable
 HandlerRegistry registry)

Description copied from class: ServerBuilder

Sets a fallback handler registry that will be looked up in if a method is not found in the primary registry. The primary registry (configured via addService()) is faster but immutable. The fallback registry is more flexible and allows implementations to mutate over time and load services on-demand.

Specified by:

fallbackHandlerRegistry in class ServerBuilder<ServerImplBuilder>

Returns:

this

decompressorRegistry

public ServerImplBuilder decompressorRegistry(@Nullable
 DecompressorRegistry registry)

Description copied from class: ServerBuilder

Set the decompression registry for use in the channel. This is an advanced API call and shouldn't be used unless you are using custom message encoding. The default supported decompressors are in DecompressorRegistry.getDefaultInstance.

Specified by:

decompressorRegistry in class ServerBuilder<ServerImplBuilder>

Returns:

this

compressorRegistry

public ServerImplBuilder compressorRegistry(@Nullable
 CompressorRegistry registry)

Description copied from class: ServerBuilder

Set the compression registry for use in the channel. This is an advanced API call and shouldn't be used unless you are using custom message encoding. The default supported compressors are in CompressorRegistry.getDefaultInstance.

Specified by:

compressorRegistry in class ServerBuilder<ServerImplBuilder>

Returns:

this

handshakeTimeout

public ServerImplBuilder handshakeTimeout(long timeout,
 TimeUnit unit)

Description copied from class: ServerBuilder

Sets the permitted time for new connections to complete negotiation handshakes before being killed. The default value is 2 minutes.

Overrides:

handshakeTimeout in class ServerBuilder<ServerImplBuilder>

Returns:

this

setBinaryLog

public ServerImplBuilder setBinaryLog(@Nullable
 BinaryLog binaryLog)

Description copied from class: ServerBuilder

Sets the BinaryLog object that this server should log to. The server does not take ownership of the object, and users are responsible for calling Closeable.close().

Overrides:

setBinaryLog in class ServerBuilder<ServerImplBuilder>

Parameters:

binaryLog - the object to provide logging.

Returns:

this

setStatsEnabled

public void setStatsEnabled(boolean value)

Disable or enable stats features. Enabled by default.

setStatsRecordStartedRpcs

public void setStatsRecordStartedRpcs(boolean value)

Disable or enable stats recording for RPC upstarts. Effective only if setStatsEnabled(boolean) is set to true. Enabled by default.

setStatsRecordFinishedRpcs

public void setStatsRecordFinishedRpcs(boolean value)

Disable or enable stats recording for RPC completions. Effective only if setStatsEnabled(boolean) is set to true. Enabled by default.

setStatsRecordRealTimeMetrics

public void setStatsRecordRealTimeMetrics(boolean value)

Disable or enable real-time metrics recording. Effective only if setStatsEnabled(boolean) is set to true. Disabled by default.

setTracingEnabled

public void setTracingEnabled(boolean value)

Disable or enable tracing features. Enabled by default.

setDeadlineTicker

public void setDeadlineTicker(Deadline.Ticker ticker)

Sets a custom deadline ticker. This should only be called from InProcessServerBuilder.

build

public Server build()

Description copied from class: ServerBuilder

Builds a server using the given parameters.

The returned service will not been started or be bound a port. You will need to start it with Server.start().

Specified by:

build in class ServerBuilder<ServerImplBuilder>

Returns:

a new Server

getTracerFactories

List<? extends ServerStreamTracer.Factory> getTracerFactories()

getChannelz

public InternalChannelz getChannelz()

getExecutorPool

public ObjectPool<? extends Executor> getExecutorPool()

Returns the internal ExecutorPool for offloading tasks.

useTransportSecurity

public ServerImplBuilder useTransportSecurity(File certChain,
 File privateKey)

Description copied from class: ServerBuilder

Makes the server use TLS.

Specified by:

useTransportSecurity in class ServerBuilder<ServerImplBuilder>

Parameters:

certChain - file containing the full certificate chain

privateKey - file containing the private key

Returns:

this