Interface GrpcRouteRegistration

@Contract public interface GrpcRouteRegistration
A contract for generated gRPC route registrations.

The implementing types are expected to be ServiceRegistry services, and will be loaded through a ServerFeature.

  • Method Summary

    Modifier and Type
    Method
    Description
    GrpcServiceDescriptor
    descriptor()
    gRPC service descriptor provided by this registration.
    default String
    socket()
    Named socket this registration should be added to.
    default boolean
    socketRequired()
    Whether the socket defined in socket() must be present for this registration, or it can be exposed on default socket.

  • Method Details

    • descriptor

      GrpcServiceDescriptor descriptor()
      gRPC service descriptor provided by this registration.
      Returns:
      gRPC service descriptor

    • socket

      default String socket()
      Named socket this registration should be added to.
      Returns:
      name of the socket

    • socketRequired

      default boolean socketRequired()
      Whether the socket defined in socket() must be present for this registration, or it can be exposed on default socket. When this method returns false and socket() returns a named socket that is not configured on the server, the registration falls back to the default socket.
      Returns:
      true if this registration must be exposed on the named socket, false by default