grpc_transport

Documentation

Index

• func InterceptorLogger(l logger.Logger) logging.Logger
• func RecoveryFunc(l logger.Logger) func(p any) (err error)
• type Config
• type GRPCServer
  • func NewServer(opts ...Option) *GRPCServer
  • func (s *GRPCServer) Enabled() bool
  • func (s *GRPCServer) Name() string
  • func (s *GRPCServer) Start(ctx context.Context) error
  • func (s *GRPCServer) Stop(context.Context) error
• type GRPCService
• type Option
  • func WithConfig(v Config) Option
  • func WithLogger(v logger.Logger) Option
  • func WithName(v string) Option
  • func WithServer(v *grpc.Server) Option
  • func WithServices(services ...GRPCService) Option

Functions

func InterceptorLogger

func InterceptorLogger(l logger.Logger) logging.Logger

func RecoveryFunc

func RecoveryFunc(l logger.Logger) func(p any) (err error)

Types

type Config

type Config struct {
	Enabled            bool   `default:"true" usage:"allows to enable grpc server" example:"true"`
	Addr               string `default:":9000" validate:"required,hostname_port" usage:"grpc server listen address" example:"localhost:9000"`
	Network            string `default:"tcp" required:"true" validate:"oneof=tcp udp" usage:"grpc server listen network: tpc/udp" example:"tcp"`
	ReflectEnabled     bool   `yaml:"reflect_enabled" default:"false" usage:"allows to enable grpc reflection service" example:"false"`
	HealthCheckEnabled bool   `yaml:"health_check_enabled" default:"false" usage:"allows to enable grpc health checker" example:"false"`
	LoggerEnabled      bool   `yaml:"logger_enabled" default:"false" usage:"allows to enable logger. available only for default grpc sevrer" example:"false"`
	RecoveryEnabled    bool   `` /* 141-byte string literal not displayed */
}

Config provides configuration for grpc server.

type GRPCServer

type GRPCServer struct {
	Config
	// contains filtered or unexported fields
}

func NewServer

func NewServer(opts ...Option) *GRPCServer

NewServer creates a new gRPC server that implements service.IService interface.

func (*GRPCServer) Enabled

func (s *GRPCServer) Enabled() bool

Enabled returns is service enabled.

func (*GRPCServer) Name

func (s *GRPCServer) Name() string

Name returns name of gRPC server.

func (*GRPCServer) Start

func (s *GRPCServer) Start(ctx context.Context) error

Start allows starting gRPC server.

func (*GRPCServer) Stop

func (s *GRPCServer) Stop(context.Context) error

Stop allows to stop grpc server.

type GRPCService

type GRPCService interface {
	Name() string
	Register(server *grpc.Server)
}

GRPCService custom interface for gRPC service.

type Option

type Option func(s *GRPCServer)

Option allows customizing gRPC server.

func WithConfig

func WithConfig(v Config) Option

WithConfig allows set custom gRPC settings.

func WithLogger

func WithLogger(v logger.Logger) Option

WithLogger allows set custom gRPC Logger.

func WithName

func WithName(v string) Option

WithName allows set custom gRPC Name.

func WithServer

func WithServer(v *grpc.Server) Option

WithServer allows set custom gRPC Server.

func WithServices

func WithServices(services ...GRPCService) Option

WithServices allows adding new gRPC Service.