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(ServerServiceDefinition service) Adds a service implementation to the handler registry.
abstract Server	build() Builds a server using the given parameters.
abstract T	executor(Executor executor) Provides a custom executor.
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)

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.

Throws:

UnsupportedOperationException - if this builder does not support dynamically adding services.

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

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