io.grpc

Class ServerBuilder<T extends ServerBuilder<T>>

java.lang.Object

io.grpc.ServerBuilder<T>

Type Parameters:

T - The concrete type of this builder.

Direct Known Subclasses:

io.grpc.internal.AbstractServerImplBuilder

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

A builder for Server instances.

Constructor Summary

Constructors

Constructor and Description
ServerBuilder()

Method Summary

Modifier and Type	Method and Description
abstract T	addService(BindableService bindableService) Adds a service implementation to the handler registry.
abstract T	addService(ServerServiceDefinition service) Adds a service implementation to the handler registry.
abstract Server	build() Builds a server using the given parameters.
abstract T	compressorRegistry(CompressorRegistry registry) Set the compression registry for use in the channel.
abstract T	decompressorRegistry(DecompressorRegistry registry) Set the decompression registry for use in the channel.
abstract T	directExecutor() Execute application code directly in the transport thread.
abstract T	executor(Executor executor) Provides a custom executor.
abstract T	fallbackHandlerRegistry(HandlerRegistry fallbackRegistry) 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)
abstract T	useTransportSecurity(File certChain, File privateKey) Makes the server use TLS.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerBuilder

public ServerBuilder()

Method Detail

forPort

public static ServerBuilder<?> forPort(int port)

directExecutor

public abstract T directExecutor()

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 executor(Executor) and passing in a direct executor. However, this is the preferred way as it may allow the transport to perform special optimizations.

executor

public abstract T executor(@Nullable
                           Executor executor)

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.

addService

public abstract T addService(ServerServiceDefinition service)

Adds a service implementation to the handler registry.

Parameters:

service - ServerServiceDefinition object

addService

public abstract T addService(BindableService bindableService)

Adds a service implementation to the handler registry.

Parameters:

bindableService - BindableService object

fallbackHandlerRegistry

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/933")
public abstract T fallbackHandlerRegistry(@Nullable
                                                                                                                 HandlerRegistry fallbackRegistry)

Sets a fallback handler registry that will be looked up in if a method is not found in the primary registry.

useTransportSecurity

public abstract T useTransportSecurity(File certChain,
                                       File privateKey)

Makes the server use TLS.

Parameters:

certChain - file containing the full certificate chain

privateKey - file containing the private key

decompressorRegistry

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1704")
public abstract T decompressorRegistry(@Nullable
                                                                                                               DecompressorRegistry registry)

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.

compressorRegistry

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1704")
public abstract T compressorRegistry(@Nullable
                                                                                                             CompressorRegistry registry)

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.

build

public abstract Server build()

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().