grpcserver

README

gRPC Server

Installation

Use go get.

go get github.com/funcards/grpc-server

License

Distributed under MIT License, please see license file within the code for more details.

Documentation

Index

• Variables
• func CtxWithLog(ctx context.Context, log *zap.Logger) context.Context
• func CtxWithNotify(ctx context.Context) (context.Context, context.CancelFunc)
• func Exit(err error, log *zap.Logger)
• func LogFromCtx(ctx context.Context) *zap.Logger
• func MustLogFromCtx(ctx context.Context) *zap.Logger
• func Serve(ctx context.Context, srvs ...func(ctx context.Context) error) error
• type Config
  • func (cfg *Config) InitDefault()
  • func (cfg *Config) Listener() (net.Listener, error)
• type Server
  • func New(cfg Config, opts ...grpc.ServerOption) Server

Variables

var StopSignals = []os.Signal{
	syscall.SIGHUP,
	syscall.SIGTERM,
	syscall.SIGINT,
	syscall.SIGTSTP,
}

Functions

func CtxWithLog

func CtxWithLog(ctx context.Context, log *zap.Logger) context.Context

func CtxWithNotify

func CtxWithNotify(ctx context.Context) (context.Context, context.CancelFunc)

func Exit

func Exit(err error, log *zap.Logger)

func LogFromCtx

func LogFromCtx(ctx context.Context) *zap.Logger

func MustLogFromCtx

func MustLogFromCtx(ctx context.Context) *zap.Logger

func Serve

func Serve(ctx context.Context, srvs ...func(ctx context.Context) error) error

Types

type Config

type Config struct {
	Network     string        `mapstructure:"network"`
	Address     string        `mapstructure:"address"`
	GracePeriod time.Duration `mapstructure:"grace_period"`
}

func (*Config) InitDefault

func (cfg *Config) InitDefault()

func (*Config) Listener

func (cfg *Config) Listener() (net.Listener, error)

type Server

type Server interface {
	RegisterService(desc *grpc.ServiceDesc, impl any)
	SetServingStatus(service string, status healthV1.HealthCheckResponse_ServingStatus)
	ListenAndServe(ctx context.Context) error
	Serve(lis net.Listener) error
	GracefulStop()
	Stop()
}

func New

func New(cfg Config, opts ...grpc.ServerOption) Server