grpc

Documentation

Index

• Variables
• type Config
• type Server
  • func (s Server) GRPC() *grpc.Server
  • func (s Server) GRPCWeb() http.Handler
  • func (s Server) ListenAndServe(context.Context) error
  • func (obj Server) Validate() error
  • func (s Server) WaitForShutdown(ctx context.Context) error
• type ServerOption
  • func WithServerLogger(logger *zap.Logger) ServerOption
  • func WithServerName(name string) ServerOption
  • func WithServerOptions(opts ...grpc.ServerOption) ServerOption
  • func WithServerPort(port int) ServerOption
  • func WithServerReflection(enabled bool) ServerOption
  • func WithServerShutdownTimeout(shutdownTimeout time.Duration) ServerOption
  • func WithService(desc *grpc.ServiceDesc, impl any) ServerOption

Variables

var NewServer = c.NewWithValidate[Server, ServerOption]

Types

type Config

type Config struct {
	Port              int  `validate:"gt=1000,lt=65536"`
	ReflectionEnabled bool `yaml:"reflection_enabled"`
	MaxRequestBytes   int  `yaml:"max_request_bytes" validate:"gt=0"`
	MaxResponseBytes  int  `yaml:"max_response_bytes" validate:"gt=0"`
}

type Server

type Server struct {
	// contains filtered or unexported fields
}

func (Server) GRPC

func (s Server) GRPC() *grpc.Server

func (Server) GRPCWeb

func (s Server) GRPCWeb() http.Handler

func (Server) ListenAndServe

func (s Server) ListenAndServe(context.Context) error

func (Server) Validate

func (obj Server) Validate() error

func (Server) WaitForShutdown

func (s Server) WaitForShutdown(ctx context.Context) error

type ServerOption

type ServerOption c.Option[Server]

func WithServerLogger

func WithServerLogger(logger *zap.Logger) ServerOption

func WithServerName

func WithServerName(name string) ServerOption

func WithServerOptions

func WithServerOptions(opts ...grpc.ServerOption) ServerOption

func WithServerPort

func WithServerPort(port int) ServerOption

func WithServerReflection

func WithServerReflection(enabled bool) ServerOption

func WithServerShutdownTimeout

func WithServerShutdownTimeout(shutdownTimeout time.Duration) ServerOption

func WithService

func WithService(desc *grpc.ServiceDesc, impl any) ServerOption