grpc

Documentation

Index

• Variables
• func IsEnabled(cfg *Config) bool
• func NewClient(target string, opts ...ClientOption) (*grpc.ClientConn, error)
• func NewDialOptions(opts ...ClientOption) []grpc.DialOption
• func UnaryClientInterceptors(opts ...ClientOption) []grpc.UnaryClientInterceptor
• func UserAgent(cfg *Config) string
• type ClientOption
  • func WithClientBreaker() ClientOption
  • func WithClientDialOption(opts ...grpc.DialOption) ClientOption
  • func WithClientLogger(logger *zap.Logger) ClientOption
  • func WithClientMetrics(meter metric.Meter) ClientOption
  • func WithClientRetry(cfg *retry.Config) ClientOption
  • func WithClientStreamInterceptors(stream ...grpc.StreamClientInterceptor) ClientOption
  • func WithClientTLS(sec *st.Config) (ClientOption, error)
  • func WithClientTimeout(timeout string) ClientOption
  • func WithClientTracer(tracer trace.Tracer) ClientOption
  • func WithClientUnaryInterceptors(unary ...grpc.UnaryClientInterceptor) ClientOption
  • func WithClientUserAgent(userAgent string) ClientOption
• type Config
• type Server
  • func NewServer(params ServerParams) (*Server, error)
  • func (s *Server) Server() *grpc.Server
  • func (s *Server) Start()
  • func (s *Server) Stop(ctx context.Context)
• type ServerParams

Variables

var Module = fx.Options(
	fx.Provide(NewServer),
)

Module for fx.

Functions

func IsEnabled

func IsEnabled(cfg *Config) bool

IsEnabled for gRPC.

func NewClient

func NewClient(target string, opts ...ClientOption) (*grpc.ClientConn, error)

NewClient for gRPC.

func NewDialOptions

func NewDialOptions(opts ...ClientOption) []grpc.DialOption

NewDialOptions for gRPC.

func UnaryClientInterceptors

func UnaryClientInterceptors(opts ...ClientOption) []grpc.UnaryClientInterceptor

UnaryClientInterceptors for gRPC.

func UserAgent

func UserAgent(cfg *Config) string

UserAgent for gRPC.

Types

type ClientOption

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

ClientOption for gRPC.

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(meter metric.Meter) ClientOption

WithClientMetrics for gRPC.

func WithClientRetry

func WithClientRetry(cfg *retry.Config) ClientOption

WithClientRetry for gRPC.

func WithClientStreamInterceptors

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

WithClientUnaryInterceptors for gRPC.

func WithClientTLS

func WithClientTLS(sec *st.Config) (ClientOption, error)

WithClientTLS for gRPC.

func WithClientTimeout

func WithClientTimeout(timeout string) ClientOption

WithClientTimeout for gRPC.

func WithClientTracer

func WithClientTracer(tracer trace.Tracer) ClientOption

WithClientTracer for gRPC.

func WithClientUnaryInterceptors

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

WithClientUnaryInterceptors for gRPC.

func WithClientUserAgent

func WithClientUserAgent(userAgent string) ClientOption

WithUserAgent for gRPC.

type Config

type Config struct {
	*server.Config `yaml:",inline" json:",inline" toml:",inline"`
}

Config for gRPC.

type Server

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

Server for gRPC.

func NewServer

func NewServer(params ServerParams) (*Server, error)

NewServer for gRPC.

func (*Server) Server

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

Server for gRPC.

func (*Server) Start

func (s *Server) Start()

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     trace.Tracer
	Meter      metric.Meter
	Limiter    *v3.Limiter
	Key        limiter.KeyFunc
	Unary      []grpc.UnaryServerInterceptor  `optional:"true"`
	Stream     []grpc.StreamServerInterceptor `optional:"true"`
}

ServerParams for gRPC.