Server instances.
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description |
|---|---|
| public abstract T | Returns: thisServerServiceDefinition object service)Adds a service implementation to the handler registry. |
| public abstract T | Returns: thisBindableService object bindableService)Adds a service implementation to the handler registry. |
| public final T | Returns: thisthe list of ServerServiceDefinition objects services)Adds a list of service implementations to the handler registry together. |
| public T | Returns: thisAdds a |
| public T | |
| public abstract Server | |
| public T | Returns: thisthe server call executor provider executorSupplier)Allows for defining a way to provide a custom executor to handle the server call. |
| public abstract T | Returns: thisSet the compression registry for use in the channel. |
| public abstract T | Returns: thisSet the decompression registry for use in the channel. |
| public abstract T | |
| public abstract T | |
| public abstract T | Returns: thisSets a fallback handler registry that will be looked up in if a method is not found in the primary registry. |
| public static ServerBuilder | |
| public T | Returns: thisSets the permitted time for new connections to complete negotiation handshakes before being killed. |
| public T | Returns: thisthe all-service interceptor interceptor)Adds a |
| public T | keepAliveTime(long keepAliveTime, TimeUnit timeUnit)
Sets the time without read activity before sending a keepalive ping. |
| public T | keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit)
Sets a time waiting for read activity after sending a keepalive ping. |
| public T | maxConnectionAge(long maxConnectionAge, TimeUnit timeUnit)
Sets the maximum connection age, connections lasting longer than which will be gracefully terminated. |
| public T | maxConnectionAgeGrace(long maxConnectionAgeGrace, TimeUnit timeUnit)
Sets the grace time for the graceful connection termination. |
| public T | maxConnectionIdle(long maxConnectionIdle, TimeUnit timeUnit)
Sets the maximum connection idle time, connections being idle for longer than which will be gracefully terminated. |
| public T | Returns: thisthe maximum number of bytes a single message can be. bytes)Sets the maximum message size allowed to be received on the server. |
| public T | Returns: thisthe maximum size of received metadata bytes)Sets the maximum size of metadata allowed to be received. |
| public T | permitKeepAliveTime(long keepAliveTime, TimeUnit timeUnit)
Specify the most aggressive keep-alive time clients are permitted to configure. |
| public T | permitKeepAliveWithoutCalls(boolean permit)
Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding RPCs on the connection. |
| public T | Returns: thisthe object to provide logging. binaryLog)Sets the BinaryLog object that this server should log to. |
| private T | |
| public abstract T | Returns: thisfile containing the full certificate chain certChain, File file containing the private key privateKey)Makes the server use TLS. |
| public T | Returns: thisInputStream containing the full certificate chain certChain, InputStream InputStream containing the private key privateKey)Makes the server use TLS. |
| ServerBuilder | back to summary |
|---|---|
| public ServerBuilder() | |
| addService | back to summary |
|---|---|
| public abstract T addService(ServerServiceDefinition service) Adds a service implementation to the handler registry.
| |
| addService | back to summary |
|---|---|
| public abstract T addService(BindableService bindableService) Adds a service implementation to the handler registry.
| |
| addServices | back to summary |
|---|---|
| public final T addServices(List<ServerServiceDefinition> services) Adds a list of service implementations to the handler registry together.
| |
| addStreamTracerFactory | back to summary |
|---|---|
| public T addStreamTracerFactory(ServerStreamTracer. Adds a
| |
| addTransportFilter | back to summary |
|---|---|
| public T addTransportFilter(ServerTransportFilter filter) Adds a
| |
| build | back to summary |
|---|---|
| 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
| |
| callExecutor | back to summary |
|---|---|
| public T callExecutor(ServerCallExecutorSupplier executorSupplier) Allows for defining a way to provide a custom executor to handle the server call.
This executor is the result of calling
It's an optional parameter. If it is provided, the
| |
| compressorRegistry | back to summary |
|---|---|
| public abstract T compressorRegistry(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
| |
| decompressorRegistry | back to summary |
|---|---|
| public abstract T decompressorRegistry(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
| |
| directExecutor | back to summary |
|---|---|
| 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 | back to summary |
|---|---|
| public abstract T executor(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.
| |
| fallbackHandlerRegistry | back to summary |
|---|---|
| public 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. The primary registry (configured via
| |
| forPort | back to summary |
|---|---|
| public static ServerBuilder Static factory for creating a new ServerBuilder.
| |
| handshakeTimeout | back to summary |
|---|---|
| public T handshakeTimeout(long timeout, TimeUnit unit) Sets the permitted time for new connections to complete negotiation handshakes before being killed. The default value is 2 minutes.
| |
| intercept | back to summary |
|---|---|
| public T intercept(ServerInterceptor interceptor) Adds a
| |
| keepAliveTime | back to summary |
|---|---|
| public T keepAliveTime(long keepAliveTime, TimeUnit timeUnit) Sets the time without read activity before sending a keepalive ping. An unreasonably small
value might be increased, and
| |
| keepAliveTimeout | back to summary |
|---|---|
| public T keepAliveTimeout(long keepAliveTimeout, TimeUnit timeUnit) Sets a time waiting for read activity after sending a keepalive ping. If the time expires without any read activity on the connection, the connection is considered dead. An unreasonably small value might be increased. Defaults to 20 seconds when supported. This value should be at least multiple times the RTT to allow for lost packets.
| |
| maxConnectionAge | back to summary |
|---|---|
| public T maxConnectionAge(long maxConnectionAge, TimeUnit timeUnit) Sets the maximum connection age, connections lasting longer than which will be gracefully
terminated. An unreasonably small value might be increased. A random jitter of +/-10% will be
added to it.
| |
| maxConnectionAgeGrace | back to summary |
|---|---|
| public T maxConnectionAgeGrace(long maxConnectionAgeGrace, TimeUnit timeUnit) Sets the grace time for the graceful connection termination. Once the max connection age
is reached, RPCs have the grace time to complete. RPCs that do not complete in time will be
cancelled, allowing the connection to terminate.
| |
| maxConnectionIdle | back to summary |
|---|---|
| public T maxConnectionIdle(long maxConnectionIdle, TimeUnit timeUnit) Sets the maximum connection idle time, connections being idle for longer than which will be
gracefully terminated. Idleness duration is defined since the most recent time the number of
outstanding RPCs became zero or the connection establishment. An unreasonably small value might
be increased.
| |
| maxInboundMessageSize | back to summary |
|---|---|
| public T maxInboundMessageSize(int bytes) Sets the maximum message size allowed to be received on the server. If not called, defaults to 4 MiB. The default provides protection to servers who haven't considered the possibility of receiving large messages while trying to be large enough to not be hit in normal usage. This method is advisory, and implementations may decide to not enforce this. Currently,
the only known transport to not enforce this is
| |
| maxInboundMetadataSize | back to summary |
|---|---|
| public T maxInboundMetadataSize(int bytes) Sets the maximum size of metadata allowed to be received. This is cumulative size of the metadata. The precise calculation is implementation-dependent, but implementations are encouraged to follow the calculation used for HTTP/2's SETTINGS_MAX_HEADER_LIST_SIZE. It sums the bytes from each entry's key and value, plus 32 bytes of overhead per entry.
| |
| permitKeepAliveTime | back to summary |
|---|---|
| public T permitKeepAliveTime(long keepAliveTime, TimeUnit timeUnit) Specify the most aggressive keep-alive time clients are permitted to configure. The server will try to detect clients exceeding this rate and when detected will forcefully close the connection. The typical default is 5 minutes when supported. Even though a default is defined that allows some keep-alives, clients must not use keep-alive without approval from the service owner. Otherwise, they may experience failures in the future if the service becomes more restrictive. When unthrottled, keep-alives can cause a significant amount of traffic and CPU usage, so clients and servers should be conservative in what they use and accept.
| |
| permitKeepAliveWithoutCalls | back to summary |
|---|---|
| public T permitKeepAliveWithoutCalls(boolean permit) Sets whether to allow clients to send keep-alive HTTP/2 PINGs even if there are no outstanding
RPCs on the connection. Defaults to
| |
| setBinaryLog | back to summary |
|---|---|
| public T setBinaryLog(BinaryLog binaryLog) 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
| |
| thisT | back to summary |
|---|---|
| private T thisT() Returns the correctly typed version of the builder. | |
| useTransportSecurity | back to summary |
|---|---|
| public abstract T useTransportSecurity(File certChain, File privateKey) Makes the server use TLS.
| |
| useTransportSecurity | back to summary |
|---|---|
| public T useTransportSecurity(InputStream certChain, InputStream privateKey) Makes the server use TLS.
| |