net.devh.springboot.autoconfigure.grpc.server

Class NettyGrpcServerFactory

java.lang.Object

net.devh.springboot.autoconfigure.grpc.server.NettyGrpcServerFactory

All Implemented Interfaces:

GrpcServerFactory

public class NettyGrpcServerFactory
extends java.lang.Object
implements GrpcServerFactory

Factory for netty based grpc servers.

Since:

5/17/16

Constructor Summary

Constructors

Constructor and Description
NettyGrpcServerFactory(GrpcServerProperties properties) Creates a new netty server factory with the given properties.

Method Summary

Modifier and Type	Method and Description
void	addCodec(GrpcCodecDefinition codec) Adds the given grpc codec definition to this factory.
void	addService(GrpcServiceDefinition service) Adds the given grpc service definition to this factory.
protected void	configure(io.grpc.netty.NettyServerBuilder builder) Configures the given netty server builder.
protected void	configureCodecs(io.grpc.netty.NettyServerBuilder builder) Configures the codecs that should be supported by the server.
protected void	configureLimits(io.grpc.netty.NettyServerBuilder builder) Configures limits such as max message sizes that should be used by the server.
protected void	configureSecurity(io.grpc.netty.NettyServerBuilder builder) Configures the security options that should be used by the server.
protected void	configureServices(io.grpc.netty.NettyServerBuilder builder) Configures the services that should be served by the server.
io.grpc.Server	createServer() Creates a new grpc server with the stored options.
void	destroy() Destroys this factory.
java.lang.String	getAddress() Gets the IP address the created server will be bound to.
int	getPort() Gets the local port the created server will use to listen to requests.

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyGrpcServerFactory

public NettyGrpcServerFactory(GrpcServerProperties properties)

Creates a new netty server factory with the given properties.

Parameters:

properties - The properties used to configure the server.

Method Detail

createServer

public io.grpc.Server createServer()

Description copied from interface: GrpcServerFactory

Creates a new grpc server with the stored options. The entire lifecycle management of the server should be managed by the calling class. This includes starting and stopping the server.

Specified by:

createServer in interface GrpcServerFactory

Returns:

The newly created grpc server.

configure

protected void configure(io.grpc.netty.NettyServerBuilder builder)

Configures the given netty server builder. This method can be overwritten to add features that are not yet supported by this library.

Parameters:

builder - The server builder to configure.

configureServices

protected void configureServices(io.grpc.netty.NettyServerBuilder builder)

Configures the services that should be served by the server.

Parameters:

builder - The server builder to configure.

configureSecurity

protected void configureSecurity(io.grpc.netty.NettyServerBuilder builder)

Configures the security options that should be used by the server.

Parameters:

builder - The server builder to configure.

configureLimits

protected void configureLimits(io.grpc.netty.NettyServerBuilder builder)

Configures limits such as max message sizes that should be used by the server.

Parameters:

builder - The server builder to configure.

configureCodecs

protected void configureCodecs(io.grpc.netty.NettyServerBuilder builder)

Configures the codecs that should be supported by the server.

Parameters:

builder - The server builder to configure.

getAddress

public java.lang.String getAddress()

Description copied from interface: GrpcServerFactory

Gets the IP address the created server will be bound to.

Specified by:

getAddress in interface GrpcServerFactory

Returns:

The IP address the server will be bound to.

getPort

public int getPort()

Description copied from interface: GrpcServerFactory

Gets the local port the created server will use to listen to requests.

Specified by:

getPort in interface GrpcServerFactory

Returns:

Gets the local port the server will use.

addService

public void addService(GrpcServiceDefinition service)

Description copied from interface: GrpcServerFactory

Adds the given grpc service definition to this factory. The created server will serve the services described by these definitions.

Note: Adding a service does not effect servers that have already been created.

Specified by:

addService in interface GrpcServerFactory

Parameters:

service - The service to add to the grpc server.

addCodec

public void addCodec(GrpcCodecDefinition codec)

Description copied from interface: GrpcServerFactory

Adds the given grpc codec definition to this factory. The created server will use the codec described by these definitions.

Note: Adding a codec does not effect servers that have already been created.

Specified by:

addCodec in interface GrpcServerFactory

Parameters:

codec - The codec to add to the grpc server.

destroy

public void destroy()

Description copied from interface: GrpcServerFactory

Destroys this factory. This does not destroy or shutdown any server that was created using this factory.

Specified by:

destroy in interface GrpcServerFactory