grpcx

Documentation

Index

• func RegisterDialOption(name string, f func(configuration *conf.Configuration) grpc.DialOption)
• func RegisterGrpcServerOption(name string, handler ServerOptionFunc)
• func RegisterGrpcStreamInterceptor(name string, handler StreamServerInterceptorFunc)
• func RegisterGrpcUnaryInterceptor(name string, handler UnaryServerInterceptorFunc)
• func RegisterStreamClientInterceptor(name string, ...)
• func RegisterUnaryClientInterceptor(name string, ...)
• type Client
  • func NewClient(cfg *conf.Configuration) (*Client, error)
  • func (c *Client) Apply(cfg *conf.Configuration) error
  • func (c *Client) Dial(target string, opts ...grpc.DialOption) (*grpc.ClientConn, error)
  • func (c *Client) DialContext(ctx context.Context, target string, opts ...grpc.DialOption) (*grpc.ClientConn, error)
• type DialOptionFunc
• type Option
  • func WithConfiguration(cfg *conf.Configuration) Option
  • func WithGracefulStop() Option
  • func WithGrpcLogger() Option
  • func WithGrpcOption(opts ...grpc.ServerOption) Option
  • func WithListener(lis net.Listener) Option
• type Server
  • func New(opts ...Option) *Server
  • func (s *Server) Apply(cfg *conf.Configuration) error
  • func (s *Server) Engine() *grpc.Server
  • func (s *Server) ListenAndServe() (err error)
  • func (s *Server) Run() error
  • func (s *Server) Start(_ context.Context) error
  • func (s *Server) Stop(_ context.Context) (err error)
• type ServerConfig
• type ServerOptionFunc
• type StreamClientInterceptorFunc
• type StreamServerInterceptorFunc
• type UnaryClientInterceptorFunc
• type UnaryServerInterceptorFunc

Functions

func RegisterDialOption

func RegisterDialOption(name string, f func(configuration *conf.Configuration) grpc.DialOption)

RegisterDialOption register grpc dial option on client side

func RegisterGrpcServerOption

func RegisterGrpcServerOption(name string, handler ServerOptionFunc)

RegisterGrpcServerOption register grpc server option

func RegisterGrpcStreamInterceptor

func RegisterGrpcStreamInterceptor(name string, handler StreamServerInterceptorFunc)

RegisterGrpcStreamInterceptor register grpc stream interceptor

func RegisterGrpcUnaryInterceptor

func RegisterGrpcUnaryInterceptor(name string, handler UnaryServerInterceptorFunc)

RegisterGrpcUnaryInterceptor register grpc unary interceptor

func RegisterStreamClientInterceptor

func RegisterStreamClientInterceptor(name string, f func(configuration *conf.Configuration) grpc.StreamClientInterceptor)

RegisterStreamClientInterceptor register grpc stream client interceptor

func RegisterUnaryClientInterceptor

func RegisterUnaryClientInterceptor(name string, f func(configuration *conf.Configuration) grpc.UnaryClientInterceptor)

RegisterUnaryClientInterceptor register grpc unary client interceptor

Types

type Client

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

Client is a grpc client helper,build a grpc client connection by configuration with registry. the configuration is like this:

server:  for grpc server info
registry:  for registry center info
client:  for grpc client info
  target:  for grpc service info using with registry or dial directly

func NewClient

func NewClient(cfg *conf.Configuration) (*Client, error)

func (*Client) Apply

func (c *Client) Apply(cfg *conf.Configuration) error

func (*Client) Dial

func (c *Client) Dial(target string, opts ...grpc.DialOption) (*grpc.ClientConn, error)

Dial creates a gRPC client connection with the given target, and covert to DialContext if client.timeout > 0

func (*Client) DialContext

func (c *Client) DialContext(ctx context.Context, target string, opts ...grpc.DialOption) (*grpc.ClientConn, error)

DialContext creates a gRPC client connection with the given target.

The target will be parsed as a URL.your resolver must parse the target.

type DialOptionFunc

type DialOptionFunc func(*conf.Configuration) grpc.DialOption

client side

type Option

type Option func(s *serverOptions)

func WithConfiguration

func WithConfiguration(cfg *conf.Configuration) Option

func WithGracefulStop

func WithGracefulStop() Option

WithGracefulStop indicate use graceful stop

func WithGrpcLogger

func WithGrpcLogger() Option

WithGrpcLogger set grpclog.LoggerV2 with the component logger named "grpc". if you need to see grpc log, you should call this option.

notice: call this while go test may cause race condition.

func WithGrpcOption

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

func WithListener

func WithListener(lis net.Listener) Option

WithListener indicate use listener. if set listener, it will ignore the address setting.

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 extended the native grpc server

func New

func New(opts ...Option) *Server

New creates a new grpc server.

func (*Server) Apply

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

Apply the configuration to the server.

func (*Server) Engine

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

func (*Server) ListenAndServe

func (s *Server) ListenAndServe() (err error)

ListenAndServe call net listen to start grpc server and registry service

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(_ context.Context) error

func (*Server) Stop

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

type ServerConfig

type ServerConfig struct {
	Addr      string `json:"addr" yaml:"addr"`
	Namespace string `json:"namespace" yaml:"namespace"`
	Version   string `json:"version" yaml:"version"`
}

type ServerOptionFunc

type ServerOptionFunc func(*conf.Configuration) grpc.ServerOption

server side

type StreamClientInterceptorFunc

type StreamClientInterceptorFunc func(*conf.Configuration) grpc.StreamClientInterceptor

type StreamServerInterceptorFunc

type StreamServerInterceptorFunc func(*conf.Configuration) grpc.StreamServerInterceptor

type UnaryClientInterceptorFunc

type UnaryClientInterceptorFunc func(*conf.Configuration) grpc.UnaryClientInterceptor

type UnaryServerInterceptorFunc

type UnaryServerInterceptorFunc func(*conf.Configuration) grpc.UnaryServerInterceptor