grpcx

Documentation

Index

• func RegisterGrpcServerOption(name string, handler func(cnf *conf.Configuration) grpc.ServerOption)
• func RegisterGrpcStreamInterceptor(name string, handler func(*conf.Configuration) grpc.StreamServerInterceptor)
• func RegisterGrpcUnaryInterceptor(name string, handler func(*conf.Configuration) grpc.UnaryServerInterceptor)
• type Option
  • func UseLogger() Option
  • func WithConfiguration(cfg *conf.Configuration) Option
  • func WithGracefulStop() Option
  • func WithGrpcOption(opts ...grpc.ServerOption) Option
• type Server
  • func New(opts ...Option) *Server
  • func (s *Server) Apply(cfg *conf.Configuration)
  • func (s *Server) Engine() *grpc.Server
  • func (s *Server) ListenAndServe() error
  • func (s *Server) Run() error
  • func (s *Server) Start(ctx context.Context) error
  • func (s *Server) Stop(ctx context.Context) (err error)

Functions

func RegisterGrpcServerOption

func RegisterGrpcServerOption(name string, handler func(cnf *conf.Configuration) grpc.ServerOption)

func RegisterGrpcStreamInterceptor

func RegisterGrpcStreamInterceptor(name string, handler func(*conf.Configuration) grpc.StreamServerInterceptor)

func RegisterGrpcUnaryInterceptor

func RegisterGrpcUnaryInterceptor(name string, handler func(*conf.Configuration) grpc.UnaryServerInterceptor)

Types

type Option

type Option func(s *serverOptions)

func UseLogger

func UseLogger() Option

UseLogger use component logger named "grpc" and set grpclog use zap logger.It is used by default.

func WithConfiguration

func WithConfiguration(cfg *conf.Configuration) Option

func WithGracefulStop

func WithGracefulStop() Option

WithGracefulStop indicate use graceful stop

func WithGrpcOption

func WithGrpcOption(opts ...grpc.ServerOption) Option

type Server

type Server struct {

	// ServiceInfos is for service discovery,it converts from grpc service info
	ServiceInfos []*registry.ServiceInfo
	// contains filtered or unexported fields
}

Server is the grpcx server

func New

func New(opts ...Option) *Server

func (*Server) Apply

func (s *Server) Apply(cfg *conf.Configuration)

func (*Server) Engine

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

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() error

func (*Server) Run

func (s *Server) Run() error

Run is a sample way to start the grpc server with gracefulStop stop

func (*Server) Start

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

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) (err error)