Package io.quarkus.grpc.runtime.config

Class GrpcServerConfiguration

java.lang.Object
io.quarkus.grpc.runtime.config.GrpcServerConfiguration
public class GrpcServerConfiguration extends Object

  • Field Details

    • useSeparateServer

      @ConfigItem(defaultValue="true") public boolean useSeparateServer
      Do we use separate HTTP server to serve gRPC requests. Set this to false if you want to use new Vert.x gRPC support, which uses existing Vert.x HTTP server.

    • xds

      @ConfigItem public Xds xds
      Configure XDS usage, if enabled.

    • inProcess

      @ConfigItem public InProcess inProcess
      Configure InProcess usage, if enabled.

    • port

      @ConfigItem(defaultValue="9000") public int port
      The gRPC Server port.

    • testPort

      @ConfigItem(defaultValue="9001") public int testPort
      The gRPC Server port used for tests.

    • host

      @ConfigItem(defaultValue="0.0.0.0") public String host
      The gRPC server host.

    • handshakeTimeout

      @ConfigItem public Optional<Duration> handshakeTimeout
      The gRPC handshake timeout.

    • maxInboundMessageSize

      @ConfigItem public OptionalInt maxInboundMessageSize
      The max inbound message size in bytes.

    • maxInboundMetadataSize

      @ConfigItem public OptionalInt maxInboundMetadataSize
      The max inbound metadata size in bytes

    • ssl

      public SslServerConfig ssl
      The SSL/TLS config.

    • plainText

      @ConfigItem(defaultValue="true") public boolean plainText
      Disables SSL, and uses plain text instead. If disabled, configure the ssl configuration.

    • alpn

      @ConfigItem(defaultValue="true") public boolean alpn
      Whether ALPN should be used.

    • transportSecurity

      @ConfigItem public GrpcTransportSecurity transportSecurity
      Configures the transport security.

    • enableReflectionService

      @ConfigItem(defaultValue="false") public boolean enableReflectionService
      Enables the gRPC Reflection Service. By default, the reflection service is only exposed in `dev` mode. This setting allows overriding this choice and enable the reflection service every time.

    • instances

      @ConfigItem(defaultValue="1") public int instances
      Number of gRPC server verticle instances. This is useful for scaling easily across multiple cores. The number should not exceed the amount of event loops.

    • netty

      @ConfigItem public GrpcServerNettyConfig netty
      Configures the netty server settings.

    • compression

      @ConfigItem public Optional<String> compression
      gRPC compression, e.g. "gzip"

  • Constructor Details

    • GrpcServerConfiguration

      public GrpcServerConfiguration()