grpc

Documentation

Index

• func NewClient(params ClientParams, opts ...ClientOption) (*grpc.ClientConn, error)
• func StreamServerInterceptor() []grpc.StreamServerInterceptor
• func UnaryServerInterceptor() []grpc.UnaryServerInterceptor
• type ClientOption
  • func WithClientBreaker() ClientOption
  • func WithClientDialOption(opts ...grpc.DialOption) ClientOption
  • func WithClientLogger(logger *zap.Logger) ClientOption
  • func WithClientMetrics(metrics *prometheus.ClientMetrics) ClientOption
  • func WithClientRetry() ClientOption
  • func WithClientSecure() ClientOption
  • func WithClientStreamInterceptors(stream ...grpc.StreamClientInterceptor) ClientOption
  • func WithClientTracer(tracer opentracing.Tracer) ClientOption
  • func WithClientUnaryInterceptors(unary ...grpc.UnaryClientInterceptor) ClientOption
• type ClientParams
• type Config
• type Server
  • func NewServer(params ServerParams) *Server
  • func (s *Server) Start(listener net.Listener)
  • func (s *Server) Stop(ctx context.Context)
• type ServerParams

Functions

func NewClient

func NewClient(params ClientParams, opts ...ClientOption) (*grpc.ClientConn, error)

NewClient to host for gRPC.

func StreamServerInterceptor

func StreamServerInterceptor() []grpc.StreamServerInterceptor

StreamServerInterceptor for gRPC.

func UnaryServerInterceptor

func UnaryServerInterceptor() []grpc.UnaryServerInterceptor

UnaryServerInterceptor for gRPC.

Types

type ClientOption

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption for HTTP.

func WithClientBreaker

func WithClientBreaker() ClientOption

WithClientBreaker for gRPC.

func WithClientDialOption

func WithClientDialOption(opts ...grpc.DialOption) ClientOption

WithClientDialOption for gRPC.

func WithClientLogger

func WithClientLogger(logger *zap.Logger) ClientOption

WithClientLogger for gRPC.

func WithClientMetrics

func WithClientMetrics(metrics *prometheus.ClientMetrics) ClientOption

WithClientConfig for gRPC.

func WithClientRetry

func WithClientRetry() ClientOption

WithClientRetry for gRPC.

func WithClientSecure

func WithClientSecure() ClientOption

WithClientSecure for gRPC.

func WithClientStreamInterceptors

func WithClientStreamInterceptors(stream ...grpc.StreamClientInterceptor) ClientOption

WithClientUnaryInterceptors for gRPC.

func WithClientTracer

func WithClientTracer(tracer opentracing.Tracer) ClientOption

WithClientConfig for gRPC.

func WithClientUnaryInterceptors

func WithClientUnaryInterceptors(unary ...grpc.UnaryClientInterceptor) ClientOption

WithClientUnaryInterceptors for gRPC.

type ClientParams

type ClientParams struct {
	Context context.Context
	Host    string
	Config  *Config
}

ClientParams for gRPC.

type Config

type Config struct {
	Retry     retry.Config `yaml:"retry" json:"retry" toml:"retry"`
	UserAgent string       `yaml:"user_agent" json:"user_agent" toml:"user_agent"`
}

Config for gRPC.

type Server

type Server struct {
	Server *grpc.Server
	// contains filtered or unexported fields
}

Server for gRPC.

func NewServer

func NewServer(params ServerParams) *Server

NewServer for gRPC.

func (*Server) Start

func (s *Server) Start(listener net.Listener)

Start the server.

func (*Server) Stop

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

Stop the server.

type ServerParams

type ServerParams struct {
	fx.In

	Shutdowner fx.Shutdowner
	Config     *Config
	Logger     *zap.Logger
	Tracer     opentracing.Tracer
	Metrics    *prometheus.ServerMetrics
	Unary      []grpc.UnaryServerInterceptor
	Stream     []grpc.StreamServerInterceptor
}

ServerParams for gRPC.