- 
- All Known Implementing Classes:
- GrpcServerBasicConfig
 
 public interface GrpcServerConfigurationThe configuration for a gRPC server.
- 
- 
Nested Class SummaryNested Classes Modifier and Type Interface Description static classGrpcServerConfiguration.BuilderAGrpcServerConfigurationbuilder.
 - 
Field SummaryFields Modifier and Type Field Description static StringDEFAULT_NAMEThe default server name.static intDEFAULT_PORTThe default grpc port.static intDEFAULT_WORKER_COUNTThe default number of worker threads that will be used if not explicitly set.
 - 
Method SummaryAll Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static GrpcServerConfiguration.Builderbuilder()Creates new instance of aserver configuration builder.static GrpcServerConfiguration.Builderbuilder(Config config)Creates new instance of aserver configuration builderwith defaults from external configuration source.Contextcontext()The top levelContextto be used by the server.static GrpcServerConfigurationcreate()Creates new instance with default values for all configuration properties.static GrpcServerConfigurationcreate(Config config)Creates new instance with values from external configuration.intmaxRapidResets()Returns the maximum allowed number of rapid resets (stream RST sent by client before any data have been sent by server).Stringname()Get the server name.intport()Get the server port.DurationrapidResetCheckPeriod()Returns the period for counting rapid resets (stream RST sent by client before any data have been sent by server).GrpcTlsDescriptortlsConfig()Returns a SslConfiguration to use with the server socket.Tracertracer()Returns an opentracing.io tracer.GrpcTracingConfigtracingConfig()Returns tracing configuration.booleanuseNativeTransport()Determine whether use native transport if possible.intworkers()Returns a count of threads in s pool used to process gRPC requests.
 
- 
- 
- 
Field Detail- 
DEFAULT_NAMEstatic final String DEFAULT_NAME The default server name.- See Also:
- Constant Field Values
 
 - 
DEFAULT_PORTstatic final int DEFAULT_PORT The default grpc port.- See Also:
- Constant Field Values
 
 - 
DEFAULT_WORKER_COUNTstatic final int DEFAULT_WORKER_COUNT The default number of worker threads that will be used if not explicitly set.
 
- 
 - 
Method Detail- 
nameString name() Get the server name.- Returns:
- the server name
 
 - 
portint port() Get the server port.- Returns:
- the server port
 
 - 
contextContext context() The top levelContextto be used by the server.- Returns:
- a context instance with registered application scoped instances
 
 - 
useNativeTransportboolean useNativeTransport() Determine whether use native transport if possible.If native transport support is enabled, gRPC server will use epoll on Linux, or kqueue on OS X. Otherwise, the standard NIO transport will be used. - Returns:
- trueif native transport should be used
 
 - 
tracerTracer tracer() Returns an opentracing.io tracer. Default isGlobalTracer.- Returns:
- a tracer to use - never null(defaulting toGlobalTracer
 
 - 
tracingConfigGrpcTracingConfig tracingConfig() Returns tracing configuration.- Returns:
- a tracing configuration.
 
 - 
workersint workers() Returns a count of threads in s pool used to process gRPC requests.Default value is CPU_COUNT * 2.- Returns:
- a workers count
 
 - 
tlsConfigGrpcTlsDescriptor tlsConfig() Returns a SslConfiguration to use with the server socket. If notnullthen the server enforces an SSL communication.- Returns:
- a TLS configuration to use
 
 - 
rapidResetCheckPeriodDuration rapidResetCheckPeriod() Returns the period for counting rapid resets (stream RST sent by client before any data have been sent by server).- Returns:
- the period for counting rapid resets
 
 - 
maxRapidResetsint maxRapidResets() Returns the maximum allowed number of rapid resets (stream RST sent by client before any data have been sent by server). When reached withinrapidResetCheckPeriod(), GOAWAY is sent to client and connection is closed.- Returns:
- the maximum allowed number of rapid resets
 
 - 
createstatic GrpcServerConfiguration create() Creates new instance with default values for all configuration properties.- Returns:
- a new instance
 
 - 
createstatic GrpcServerConfiguration create(Config config) Creates new instance with values from external configuration.- Parameters:
- config- the externalized configuration
- Returns:
- a new instance
 
 - 
builderstatic GrpcServerConfiguration.Builder builder() Creates new instance of aserver configuration builder.- Returns:
- a new builder instance
 
 - 
builderstatic GrpcServerConfiguration.Builder builder(Config config) Creates new instance of aserver configuration builderwith defaults from external configuration source.- Parameters:
- config- the externalized configuration
- Returns:
- a new builder instance
 
 
- 
 
-