io.grpc.internal

Class AbstractServerImplBuilder<T extends AbstractServerImplBuilder<T>>

java.lang.Object

io.grpc.ServerBuilder<T>

io.grpc.internal.AbstractServerImplBuilder<T>

Type Parameters:

T - The concrete type for this builder.

Direct Known Subclasses:

InProcessServerBuilder, NettyServerBuilder

public abstract class AbstractServerImplBuilder<T extends AbstractServerImplBuilder<T>>
extends ServerBuilder<T>

The base class for server builders.

Constructor Summary

Constructors

Constructor and Description
AbstractServerImplBuilder()

Method Summary

Modifier and Type	Method and Description
T	addService(BindableService bindableService) Adds a service implementation to the handler registry.
T	addService(ServerServiceDefinition service) Adds a service implementation to the handler registry.
T	addStreamTracerFactory(ServerStreamTracer.Factory factory) Adds a ServerStreamTracer.Factory to measure server-side traffic.
T	addTransportFilter(ServerTransportFilter filter) Adds a ServerTransportFilter.
Server	build() Builds a server using the given parameters.
protected abstract List<? extends InternalServer>	buildTransportServers(List<? extends ServerStreamTracer.Factory> streamTracerFactories) Children of AbstractServerBuilder should override this method to provide transport specific information for the server.
T	compressorRegistry(CompressorRegistry registry) Set the compression registry for use in the channel.
T	decompressorRegistry(DecompressorRegistry registry) Set the decompression registry for use in the channel.
T	directExecutor() Execute application code directly in the transport thread.
T	executor(Executor executor) Provides a custom executor.
T	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)
protected io.grpc.InternalChannelz	getChannelz()
protected TransportTracer.Factory	getTransportTracerFactory()
T	handshakeTimeout(long timeout, TimeUnit unit) Sets the permitted time for new connections to complete negotiation handshakes before being killed.
T	intercept(ServerInterceptor interceptor) Adds a ServerInterceptor that is run for all services on the server.
protected T	overrideCensusStatsModule(CensusStatsModule censusStats) Override the default stats implementation.
T	setBinaryLog(BinaryLog binaryLog) Sets the BinaryLog object that this server should log to.
protected void	setStatsEnabled(boolean value) Disable or enable stats features.
protected void	setStatsRecordFinishedRpcs(boolean value) Disable or enable stats recording for RPC completions.
protected void	setStatsRecordRealTimeMetrics(boolean value) Disable or enable real-time metrics recording.
protected void	setStatsRecordStartedRpcs(boolean value) Disable or enable stats recording for RPC upstarts.
protected void	setTracingEnabled(boolean value) Disable or enable tracing features.
T	setTransportTracerFactory(TransportTracer.Factory transportTracerFactory)

Methods inherited from class io.grpc.ServerBuilder

maxInboundMessageSize, maxInboundMetadataSize, useTransportSecurity, useTransportSecurity

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractServerImplBuilder

public AbstractServerImplBuilder()

Method Detail

forPort

public static ServerBuilder<?> forPort(int port)

directExecutor

public final T 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<T extends AbstractServerImplBuilder<T>>

Returns:

this

executor

public final T 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<T extends AbstractServerImplBuilder<T>>

Returns:

this

addService

public final T addService(ServerServiceDefinition service)

Description copied from class: ServerBuilder

Adds a service implementation to the handler registry.

Specified by:

addService in class ServerBuilder<T extends AbstractServerImplBuilder<T>>

Parameters:

service - ServerServiceDefinition object

Returns:

this

addService

public final T addService(BindableService bindableService)

Description copied from class: ServerBuilder

Adds a service implementation to the handler registry. If bindableService implements InternalNotifyOnServerBuild, the service will receive a reference to the generated server instance upon build().

Specified by:

addService in class ServerBuilder<T extends AbstractServerImplBuilder<T>>

Parameters:

bindableService - BindableService object

Returns:

this

addTransportFilter

public final T 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<T extends AbstractServerImplBuilder<T>>

Returns:

this

intercept

public final T 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<T extends AbstractServerImplBuilder<T>>

Parameters:

interceptor - the all-service interceptor

Returns:

this

addStreamTracerFactory

public final T 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. Tracers should not

Overrides:

addStreamTracerFactory in class ServerBuilder<T extends AbstractServerImplBuilder<T>>

Returns:

this

fallbackHandlerRegistry

public final T 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<T extends AbstractServerImplBuilder<T>>

Returns:

this

decompressorRegistry

public final T 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<T extends AbstractServerImplBuilder<T>>

Returns:

this

compressorRegistry

public final T 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<T extends AbstractServerImplBuilder<T>>

Returns:

this

handshakeTimeout

public final T handshakeTimeout(long timeout,
                                TimeUnit unit)

Description copied from class: ServerBuilder

Sets the permitted time for new connections to complete negotiation handshakes before being killed.

Overrides:

handshakeTimeout in class ServerBuilder<T extends AbstractServerImplBuilder<T>>

Returns:

this

setBinaryLog

public final T 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<T extends AbstractServerImplBuilder<T>>

Parameters:

binaryLog - the object to provide logging.

Returns:

this

overrideCensusStatsModule

protected final T overrideCensusStatsModule(@Nullable
                                            CensusStatsModule censusStats)

Override the default stats implementation.

setTransportTracerFactory

public final T setTransportTracerFactory(TransportTracer.Factory transportTracerFactory)

setStatsEnabled

protected void setStatsEnabled(boolean value)

Disable or enable stats features. Enabled by default.

setStatsRecordStartedRpcs

protected 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

protected 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

protected void setStatsRecordRealTimeMetrics(boolean value)

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

setTracingEnabled

protected void setTracingEnabled(boolean value)

Disable or enable tracing features. Enabled by default.

build

public final 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<T extends AbstractServerImplBuilder<T>>

Returns:

a new Server

getChannelz

protected final io.grpc.InternalChannelz getChannelz()

getTransportTracerFactory

protected final TransportTracer.Factory getTransportTracerFactory()

buildTransportServers

protected abstract List<? extends InternalServer> buildTransportServers(List<? extends ServerStreamTracer.Factory> streamTracerFactories)

Children of AbstractServerBuilder should override this method to provide transport specific information for the server. This method is mean for Transport implementors and should not be used by normal users.

Parameters:

streamTracerFactories - an immutable list of stream tracer factories