xgrpc

Documentation

Index

• func NewSentinelUnaryServerInterceptor() grpc.UnaryServerInterceptor
• func NewTraceStreamServerInterceptor() grpc.StreamServerInterceptor
• func NewTraceUnaryServerInterceptor() grpc.UnaryServerInterceptor
• func StreamInterceptorChain(interceptors ...grpc.StreamServerInterceptor) grpc.StreamServerInterceptor
• func UnaryInterceptorChain(interceptors ...grpc.UnaryServerInterceptor) grpc.UnaryServerInterceptor
• type Config
  • func DefaultConfig() *Config
  • func RawConfig(key string) *Config
  • func StdConfig(name string) *Config
  • func (config Config) Address() string
  • func (config *Config) Build() (*Server, error)
  • func (config *Config) MustBuild() *Server
  • func (config *Config) WithLogger(logger *xlog.Logger) *Config
  • func (config *Config) WithServerOption(options ...grpc.ServerOption) *Config
  • func (config *Config) WithStreamInterceptor(intes ...grpc.StreamServerInterceptor) *Config
  • func (config *Config) WithUnaryInterceptor(intes ...grpc.UnaryServerInterceptor) *Config
• type Server
  • func (s *Server) GracefulStop(ctx context.Context) error
  • func (s *Server) Healthz() bool
  • func (s *Server) Info() *server.ServiceInfo
  • func (s *Server) Serve() error
  • func (s *Server) Stop() error

Functions

func NewSentinelUnaryServerInterceptor

func NewSentinelUnaryServerInterceptor() grpc.UnaryServerInterceptor

func NewTraceStreamServerInterceptor

func NewTraceStreamServerInterceptor() grpc.StreamServerInterceptor

func NewTraceUnaryServerInterceptor

func NewTraceUnaryServerInterceptor() grpc.UnaryServerInterceptor

func StreamInterceptorChain

func StreamInterceptorChain(interceptors ...grpc.StreamServerInterceptor) grpc.StreamServerInterceptor

StreamInterceptorChain returns stream interceptors chain.

func UnaryInterceptorChain

func UnaryInterceptorChain(interceptors ...grpc.UnaryServerInterceptor) grpc.UnaryServerInterceptor

UnaryInterceptorChain returns interceptors chain.

Types

type Config

type Config struct {
	Name       string `json:"name"`
	Host       string `json:"host"`
	Port       int    `json:"port"`
	Deployment string `json:"deployment"`
	// Network network type, tcp4 by default
	Network string `json:"network" toml:"network"`
	// EnableAccessLog enable Access Interceptor, true by default
	EnableAccessLog bool
	// DisableTrace disable Trace Interceptor, false by default
	DisableTrace bool
	// DisableMetric disable Metric Interceptor, false by default
	DisableMetric bool
	// DisableSentinel disable Sentinel Interceptor, false by default
	DisableSentinel bool
	// SlowQueryThresholdInMilli, request will be colored if cost over this threshold value
	SlowQueryThresholdInMilli int64
	// ServiceAddress service address in registry info, default to 'Host:Port'
	ServiceAddress string
	// EnableTLS
	EnableTLS bool
	// CaFile
	CaFile string
	// CertFile
	CertFile string
	// PrivateFile
	PrivateFile string

	Labels map[string]string `json:"labels"`
	// contains filtered or unexported fields
}

Config ...

func DefaultConfig

func DefaultConfig() *Config

DefaultConfig represents default config User should construct config base on DefaultConfig

func RawConfig

func RawConfig(key string) *Config

RawConfig ...

func StdConfig

func StdConfig(name string) *Config

StdConfig represents Standard gRPC Server config which will parse config by conf package, panic if no config key found in conf

func (Config) Address

func (config Config) Address() string

Address ...

func (*Config) Build

func (config *Config) Build() (*Server, error)

Build ...

func (*Config) MustBuild

func (config *Config) MustBuild() *Server

func (*Config) WithLogger

func (config *Config) WithLogger(logger *xlog.Logger) *Config

WithLogger ...

func (*Config) WithServerOption

func (config *Config) WithServerOption(options ...grpc.ServerOption) *Config

WithServerOption inject server option to grpc server User should not inject interceptor option, which is recommend by WithStreamInterceptor and WithUnaryInterceptor

func (*Config) WithStreamInterceptor

func (config *Config) WithStreamInterceptor(intes ...grpc.StreamServerInterceptor) *Config

WithStreamInterceptor inject stream interceptors to server option

func (*Config) WithUnaryInterceptor

func (config *Config) WithUnaryInterceptor(intes ...grpc.UnaryServerInterceptor) *Config

WithUnaryInterceptor inject unary interceptors to server option

type Server

type Server struct {
	*grpc.Server

	*Config
	// contains filtered or unexported fields
}

Server ...

func (*Server) GracefulStop

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

GracefulStop implements server.Server interface it will stop echo server gracefully

func (*Server) Healthz

func (s *Server) Healthz() bool

func (*Server) Info

func (s *Server) Info() *server.ServiceInfo

Info returns server info, used by governor and consumer balancer

func (*Server) Serve

func (s *Server) Serve() error

Server implements server.Server interface.

func (*Server) Stop

func (s *Server) Stop() error

Stop implements server.Server interface it will terminate echo server immediately