io.servicetalk.grpc.api

Class GrpcServiceFactory<Filter extends Service,Service extends GrpcService,FilterFactory extends GrpcServiceFilterFactory<Filter,Service>>

Object

GrpcServiceFactory<Filter,Service,FilterFactory>

Type Parameters:

Filter - Type for service filter

Service - Type for service

FilterFactory - Type for filter factory

public abstract class GrpcServiceFactory<Filter extends Service,Service extends GrpcService,FilterFactory extends GrpcServiceFilterFactory<Filter,Service>>
extends Object

A factory for binding a gRPC service to a server using a GrpcServiceFactory.ServerBinder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GrpcServiceFactory.ServerBinder A utility to bind an HTTP service for gRPC with an appropriate programming model.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GrpcServiceFactory(GrpcRoutes<Service> routes) Creates new instance.

Method Summary

Modifier and Type	Method and Description
GrpcServiceFactory<Filter,Service,FilterFactory>	appendServiceFilter(FilterFactory before) Appends the passed FilterFactory to this factory.
protected abstract FilterFactory	appendServiceFilterFactory(FilterFactory existing, FilterFactory append) Appends the passed FilterFactory to this service factory.
Single<ServerContext>	bind(GrpcServiceFactory.ServerBinder binder, ExecutionContext executionContext) Use the passed GrpcServiceFactory.ServerBinder to bind an appropriate gRPC service for the server.

Methods inherited from class Object

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

Constructor Detail

GrpcServiceFactory

protected GrpcServiceFactory(GrpcRoutes<Service> routes)

Creates new instance.

Parameters:

routes - GrpcRoutes that will hold the routes for the constructed service.

Method Detail

bind

public final Single<ServerContext> bind(GrpcServiceFactory.ServerBinder binder,
                                        ExecutionContext executionContext)

Use the passed GrpcServiceFactory.ServerBinder to bind an appropriate gRPC service for the server.

Parameters:

binder - GrpcServiceFactory.ServerBinder to bind gRPC service to the server.

executionContext - ExecutionContext to use for the service.

Returns:

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

appendServiceFilter

public GrpcServiceFactory<Filter,Service,FilterFactory> appendServiceFilter(FilterFactory before)

Appends the passed FilterFactory to this factory.

The order of execution of these filters are in order of append. If 3 filters are added as follows:

     filter1.append(filter2).append(filter3)
 

making a request to a client wrapped by this filter chain the order of invocation of these filters will be:

     filter1 => filter2 => filter3 => client
 

Parameters:

before - the factory to apply before this factory is applied

Returns:

this

appendServiceFilterFactory

protected abstract FilterFactory appendServiceFilterFactory(FilterFactory existing,
                                                            FilterFactory append)

Appends the passed FilterFactory to this service factory.

Parameters:

existing - Existing FilterFactory.

append - FilterFactory to append to existing.

Returns:

a composed factory that first applies the before factory and then applies existing factory