Package io.quarkus.grpc.runtime.config

Interface GrpcServerConfiguration

public interface GrpcServerConfiguration

  • Method Details

    • useSeparateServer

      @WithDefault("true") 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

      @ConfigDocSection(generated=true) GrpcServerConfiguration.Xds xds()
      Configure XDS usage, if enabled.

    • inProcess

      InProcess inProcess()
      Configure InProcess usage, if enabled.

    • port

      @WithDefault("9000") int port()
      The gRPC Server port.

    • testPort

      @WithDefault("9001") int testPort()
      The gRPC Server port used for tests.

    • host

      @WithDefault("0.0.0.0") String host()
      The gRPC server host.

    • handshakeTimeout

      Optional<Duration> handshakeTimeout()
      The gRPC handshake timeout.

    • maxInboundMessageSize

      OptionalInt maxInboundMessageSize()
      The max inbound message size in bytes.

      When using a single server (using quarkus.grpc.server.use-separate-server=false), the default value is 256KB. When using a separate server (using quarkus.grpc.server.use-separate-server=true), the default value is 4MB.

    • maxInboundMetadataSize

      OptionalInt maxInboundMetadataSize()
      The max inbound metadata size in bytes

    • ssl

      GrpcServerConfiguration.SslServerConfig ssl()
      The SSL/TLS config.

    • plainText

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

    • isPlainTextEnabled

      default boolean isPlainTextEnabled()

    • alpn

      @WithDefault("true") boolean alpn()
      Whether ALPN should be used.

    • transportSecurity

      GrpcServerConfiguration.GrpcTransportSecurity transportSecurity()
      Configures the transport security.

    • enableReflectionService

      @WithDefault("false") 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

      @WithDefault("1") 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

      GrpcServerConfiguration.GrpcServerNettyConfig netty()
      Configures the netty server settings.

    • compression

      Optional<String> compression()
      gRPC compression, e.g. "gzip"