net.devh.boot.grpc.server.config

Class GrpcServerProperties

java.lang.Object

net.devh.boot.grpc.server.config.GrpcServerProperties

@ConfigurationProperties(value="grpc.server")
public class GrpcServerProperties
extends java.lang.Object

The properties for the grpc server that will be started as part of the application.

Since:

5/17/16

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GrpcServerProperties.Security The security configuration for the gRPC server.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANY_IP_ADDRESS A constant that defines, that the server should listen to any IPv4 and IPv6 address.
static java.lang.String	ANY_IPv4_ADDRESS A constant that defines, that the server should listen to any IPv4 address.
static java.lang.String	ANY_IPv6_ADDRESS A constant that defines, that the server should listen to any IPv6 address.

Constructor Summary

Constructors

Constructor and Description
GrpcServerProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getMaxInboundMessageSize() Gets the maximum message size in bytes allowed to be received by the server.
int	getPort() Gets the port the server should listen on.
void	setMaxMessageSize(int maxMessageSize) Deprecated. Use the maxInboundMessageSize property instead.

Methods inherited from class java.lang.Object

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

Field Detail

ANY_IP_ADDRESS

public static final java.lang.String ANY_IP_ADDRESS

A constant that defines, that the server should listen to any IPv4 and IPv6 address.

See Also:

Constant Field Values

ANY_IPv4_ADDRESS

public static final java.lang.String ANY_IPv4_ADDRESS

A constant that defines, that the server should listen to any IPv4 address.

See Also:

Constant Field Values

ANY_IPv6_ADDRESS

public static final java.lang.String ANY_IPv6_ADDRESS

A constant that defines, that the server should listen to any IPv6 address.

See Also:

Constant Field Values

Constructor Detail

GrpcServerProperties

public GrpcServerProperties()

Method Detail

getPort

public int getPort()

Gets the port the server should listen on. Defaults to 9090. If set to 0 a random available port will be selected and used.

Returns:

The server port to listen to.

setMaxMessageSize

@Deprecated
public void setMaxMessageSize(int maxMessageSize)

Deprecated. Use the maxInboundMessageSize property instead.

Sets the maximum message size to use.

Parameters:

maxMessageSize - The max message size to use.

getMaxInboundMessageSize

public java.lang.Integer getMaxInboundMessageSize()

Gets the maximum message size in bytes allowed to be received by the server. If not set (null) then it will default to DEFAULT_MAX_MESSAGE_SIZE. If set to -1 then it will use Integer.MAX_VALUE as limit.

Returns:

The maximum message size in bytes allowed or null if the default should be used.