Interface GrpcConfig

All Superinterfaces:

NamedService, ProtocolConfig, Prototype.Api

All Known Implementing Classes:

GrpcConfig.BuilderBase.GrpcConfigImpl

public interface GrpcConfig
extends Prototype.Api

gRPC protocol configuration.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GrpcConfig.Builder	Fluent API builder for GrpcConfig.
static class	GrpcConfig.BuilderBase<BUILDER extends GrpcConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends GrpcConfig>	Fluent API builder base for GrpcConfig.

Method Summary

Modifier and Type	Method	Description
static GrpcConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static GrpcConfig.Builder	builder(GrpcConfig instance)	Create a new fluent API builder from an existing instance.
static GrpcConfig	create()	Create a new instance with default values.
static GrpcConfig	create(Config config)	Create a new instance from configuration.
boolean	enableCompression()	Whether to support compression if requested by a client.
boolean	enableMetrics()	Whether to collect metrics for gRPC server calls.
default List<GrpcServerService>	grpcServices()	gRPC server services.
int	maxReadBufferSize()	Max size of gRPC reading buffer.
String	name()	Protocol configuration name.
String	type()	Protocol configuration type.

Methods inherited from interface ProtocolConfig

enabled, transportBindingTypes

Modifier and Type	Method	Description
default boolean	enabled()	Whether this protocol configuration is enabled.
default Set<String>	transportBindingTypes()	Transport binding provider keys compatible with this protocol.

Method Details

builder

static GrpcConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static GrpcConfig.Builder builder(GrpcConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static GrpcConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static GrpcConfig create()

Create a new instance with default values.

Returns:

a new instance

name

String name()

Protocol configuration name.

Specified by:

name in interface NamedService

Returns:

name of this configuration

type

String type()

Protocol configuration type.

Specified by:

type in interface NamedService

Returns:

type of this configuration

enableMetrics

boolean enableMetrics()

Whether to collect metrics for gRPC server calls.

Returns:

metrics flag

enableCompression

boolean enableCompression()

Whether to support compression if requested by a client. If explicitly disabled, no compression will ever be used by the server even if a client-compatible compressor is found.

Returns:

true if compression is enabled

grpcServices

default List<GrpcServerService> grpcServices()

gRPC server services. Services are discovered automatically by default.

Returns:

services to use

maxReadBufferSize

int maxReadBufferSize()

Max size of gRPC reading buffer. If receiving an entity larger than this, processing will be aborted. This can help prevent DoS attacks. Default set to 4 MB.

Returns:

max read buffer size