io.grpc

Class AbstractServerBuilder<BuilderT extends AbstractServerBuilder<BuilderT>>

java.lang.Object

io.grpc.AbstractServerBuilder<BuilderT>

Type Parameters:

BuilderT - The concrete type for this builder.

Direct Known Subclasses:

NettyServerBuilder

public abstract class AbstractServerBuilder<BuilderT extends AbstractServerBuilder<BuilderT>>
extends Object

The base class for server builders.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractServerBuilder.ServerEssentials

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractServerBuilder() Constructs with a MutableHandlerRegistry created internally.
protected	AbstractServerBuilder(HandlerRegistry registry) Constructs using a given handler registry.

Method Summary

Modifier and Type	Method and Description
BuilderT	addService(ServerServiceDefinition service) Adds a service implementation to the handler registry.
ServerImpl	build() Builds a server using the given parameters.
protected abstract AbstractServerBuilder.ServerEssentials	buildEssentials()
BuilderT	executor(ExecutorService executor) Provides a custom executor.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractServerBuilder

protected AbstractServerBuilder(HandlerRegistry registry)

Constructs using a given handler registry.

AbstractServerBuilder

protected AbstractServerBuilder()

Constructs with a MutableHandlerRegistry created internally.

Method Detail

executor

public final BuilderT executor(ExecutorService 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 final BuilderT addService(ServerServiceDefinition service)

Adds a service implementation to the handler registry.

This is supported only if the user didn't provide a handler registry, or the provided one is a MutableHandlerRegistry. Otherwise it throws an UnsupportedOperationException.

build

public ServerImpl 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 ServerImpl.start().

buildEssentials

protected abstract AbstractServerBuilder.ServerEssentials buildEssentials()