com.salesforce.grpc.contrib.spring

Class GrpcServerHost

java.lang.Object

com.salesforce.grpc.contrib.spring.GrpcServerHost

All Implemented Interfaces:

AutoCloseable, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class GrpcServerHost
extends Object
implements AutoCloseable, org.springframework.context.ApplicationContextAware

GrpcServerHost configures a gRPC Server with services obtained from the ApplicationContext and manages that server's lifecycle. Services are discovered by finding BindableService implementations that are annotated with GrpcService.

Constructor Summary

Constructors

Constructor and Description
GrpcServerHost(int port) Construct a GrpcServerHost on a given port with a three second shutdown timeout.
GrpcServerHost(int port, long shutdownWaitTimeInMillis) Construct a GrpcServerHost on a given port with a given shutdown timeout.
GrpcServerHost(int port, long shutdownWaitTimeInMillis, GrpcServerFactory serverFactory) Construct a GrpcServerHost on a given port with a given shutdown timeout and GrpcServerFactory.

Method Summary

Modifier and Type	Method and Description
void	close() Shutdown the gRPC Server when this object is closed.
int	getPort() Returns the actual port of the running gRPC server.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	start() Start the gRPC Server.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcServerHost

public GrpcServerHost(int port)

Construct a GrpcServerHost on a given port with a three second shutdown timeout.

Parameters:

port - The port to listen on

GrpcServerHost

public GrpcServerHost(int port,
                      long shutdownWaitTimeInMillis)

Construct a GrpcServerHost on a given port with a given shutdown timeout.

Parameters:

port - The port to listen on

shutdownWaitTimeInMillis - Timeout for shutdown

GrpcServerHost

public GrpcServerHost(int port,
                      long shutdownWaitTimeInMillis,
                      GrpcServerFactory serverFactory)

Construct a GrpcServerHost on a given port with a given shutdown timeout and GrpcServerFactory.

Parameters:

port - The port to listen on

shutdownWaitTimeInMillis - Timeout for shutdown

serverFactory - A factory to construct gRPC Server instances

Method Detail

setApplicationContext

public void setApplicationContext(@Nonnull
                                  org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException

getPort

public final int getPort()

Returns the actual port of the running gRPC server. The port is only available once the server is up and running.

Throws:

IllegalStateException - if called either before the server has started or after it has stopped

start

public void start()
           throws IOException

Start the gRPC Server.

Throws:

IOException - if unable to bind to server address or port

IllegalStateException - if any non-BindableService classes are annotated with GrpcService

close

public void close()
           throws Exception

Shutdown the gRPC Server when this object is closed.

Specified by:

close in interface AutoCloseable

Throws:

Exception