io.servicetalk.grpc.api

Class DelegatingGrpcServerBuilder

Object

DelegatingGrpcServerBuilder

All Implemented Interfaces:

GrpcServerBuilder

public class DelegatingGrpcServerBuilder
extends Object
implements GrpcServerBuilder

A GrpcServerBuilder that delegates all methods to another GrpcServerBuilder.

Nested Class Summary

Nested classes/interfaces inherited from interface GrpcServerBuilder

GrpcServerBuilder.HttpInitializer

Constructor Summary

Constructors

Constructor and Description
DelegatingGrpcServerBuilder(GrpcServerBuilder delegate)

Method Summary

Modifier and Type	Method and Description
GrpcServerBuilder	defaultTimeout(Duration defaultTimeout) Set a default timeout during which gRPC calls are expected to complete.
GrpcServerBuilder	defaultTimeout(Duration defaultTimeout, boolean appendTimeoutFilter) Set a default timeout during which gRPC calls are expected to complete.
protected GrpcServerBuilder	delegate() Returns the GrpcServerBuilder delegate.
GrpcServerBuilder	initializeHttp(GrpcServerBuilder.HttpInitializer initializer) Set a function which can configure the underlying HttpServerBuilder used for the transport layer.
GrpcServerBuilder	lifecycleObserver(GrpcLifecycleObserver lifecycleObserver) Sets a GrpcLifecycleObserver that provides visibility into gRPC lifecycle events.
Single<GrpcServerContext>	listen(GrpcBindableService<?>... services) Starts this server and returns the GrpcServerContext after the server has been successfully started.
Single<GrpcServerContext>	listen(GrpcServiceFactory<?>... serviceFactories) Starts this server and returns the GrpcServerContext after the server has been successfully started.
GrpcServerContext	listenAndAwait(GrpcBindableService<?>... services) Starts this server and returns the GrpcServerContext after the server has been successfully started.
GrpcServerContext	listenAndAwait(GrpcServiceFactory<?>... serviceFactories) Starts this server and returns the GrpcServerContext after the server has been successfully started.
String	toString()

Methods inherited from class Object

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

Constructor Detail

DelegatingGrpcServerBuilder

public DelegatingGrpcServerBuilder(GrpcServerBuilder delegate)

Method Detail

delegate

protected final GrpcServerBuilder delegate()

Returns the GrpcServerBuilder delegate.

Returns:

Delegate GrpcServerBuilder.

toString

public String toString()

Overrides:

toString in class Object

initializeHttp

public GrpcServerBuilder initializeHttp(GrpcServerBuilder.HttpInitializer initializer)

Description copied from interface: GrpcServerBuilder

Set a function which can configure the underlying HttpServerBuilder used for the transport layer.

Specified by:

initializeHttp in interface GrpcServerBuilder

Parameters:

initializer - Initializes the underlying HTTP transport builder.

Returns:

this.

defaultTimeout

public GrpcServerBuilder defaultTimeout(Duration defaultTimeout)

Description copied from interface: GrpcServerBuilder

Set a default timeout during which gRPC calls are expected to complete. This default will be used only if the request includes no timeout; any value specified in client request will supersede this default.

Specified by:

defaultTimeout in interface GrpcServerBuilder

Parameters:

defaultTimeout - Duration of default timeout which must be positive non-zero.

Returns:

this.

See Also:

GrpcServerBuilder.defaultTimeout(Duration, boolean)

defaultTimeout

public GrpcServerBuilder defaultTimeout(@Nullable
                                        Duration defaultTimeout,
                                        boolean appendTimeoutFilter)

Description copied from interface: GrpcServerBuilder

Set a default timeout during which gRPC calls are expected to complete. This default will be used only if the request includes no timeout; any value specified in client request will supersede this default.

Specified by:

defaultTimeout in interface GrpcServerBuilder

Parameters:

defaultTimeout - Duration of default timeout which must be positive non-zero, or null if a default shouldn't be applied.

appendTimeoutFilter - true to append the filter that enforces deadline propagation. false to not append the filter and therefore not enforce deadlines. If false you can manually insert GrpcFilters.newGrpcDeadlineServerFilterFactory(Duration) in your preferred order use GrpcServerBuilder.initializeHttp(io.servicetalk.grpc.api.GrpcServerBuilder.HttpInitializer) and HttpServerBuilder.appendNonOffloadingServiceFilter(StreamingHttpServiceFilterFactory) (to force ordering before any offloading filters) or HttpServerBuilder.appendServiceFilter(StreamingHttpServiceFilterFactory) (if you require different ordering).

Returns:

this.

lifecycleObserver

public GrpcServerBuilder lifecycleObserver(GrpcLifecycleObserver lifecycleObserver)

Description copied from interface: GrpcServerBuilder

Sets a GrpcLifecycleObserver that provides visibility into gRPC lifecycle events.

Note, if GrpcServerBuilder.initializeHttp(HttpInitializer) is used to configure HttpServerBuilder.lifecycleObserver(HttpLifecycleObserver) – that will override the value specified using this method. Please choose only one approach.

Specified by:

lifecycleObserver in interface GrpcServerBuilder

Parameters:

lifecycleObserver - A GrpcLifecycleObserver that provides visibility into gRPC lifecycle events.

Returns:

this.

listen

public Single<GrpcServerContext> listen(GrpcBindableService<?>... services)

Description copied from interface: GrpcServerBuilder

Starts this server and returns the GrpcServerContext after the server has been successfully started.

If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listen in interface GrpcServerBuilder

Parameters:

services - GrpcBindableService(s) to create a gRPC service.

Returns:

A Single that completes when the server is successfully started or terminates with an error if the server could not be started.

listen

public Single<GrpcServerContext> listen(GrpcServiceFactory<?>... serviceFactories)

Description copied from interface: GrpcServerBuilder

Starts this server and returns the GrpcServerContext after the server has been successfully started.

If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listen in interface GrpcServerBuilder

Parameters:

serviceFactories - GrpcServiceFactory(s) to create a gRPC service.

Returns:

A Single that completes when the server is successfully started or terminates with an error if the server could not be started.

listenAndAwait

public GrpcServerContext listenAndAwait(GrpcServiceFactory<?>... serviceFactories)
                                 throws Exception

Description copied from interface: GrpcServerBuilder

Starts this server and returns the GrpcServerContext after the server has been successfully started.

If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listenAndAwait in interface GrpcServerBuilder

Parameters:

serviceFactories - GrpcServiceFactory(s) to create a gRPC service.

Returns:

A GrpcServerContext by blocking the calling thread until the server is successfully started or throws an Exception if the server could not be started.

Throws:

Exception - if the server could not be started.

listenAndAwait

public GrpcServerContext listenAndAwait(GrpcBindableService<?>... services)
                                 throws Exception

Description copied from interface: GrpcServerBuilder

Starts this server and returns the GrpcServerContext after the server has been successfully started.

If the underlying protocol (eg. TCP) supports it this will result in a socket bind/listen on address.

Specified by:

listenAndAwait in interface GrpcServerBuilder

Parameters:

services - GrpcBindableService(s) to create a gRPC service.

Returns:

A GrpcServerContext by blocking the calling thread until the server is successfully started or throws an Exception if the server could not be started.

Throws:

Exception - if the server could not be started.