grpc

Documentation

Index

• func NewClient(context context.Context, host string, opts ...ClientOption) (*grpc.ClientConn, error)
• func NewServer(params ServerParams, opts ...grpc.ServerOption) *grpc.Server
• func StreamServerInterceptor() []grpc.StreamServerInterceptor
• func UnaryServerInterceptor() []grpc.UnaryServerInterceptor
• type ClientOption
  • func WithClientBreaker() ClientOption
  • func WithClientConfig(config *Config) ClientOption
  • func WithClientDialOption(opts ...grpc.DialOption) ClientOption
  • func WithClientLogger(logger *zap.Logger) 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 Config
• type ServerParams

Functions

func NewClient

func NewClient(context context.Context, host string, opts ...ClientOption) (*grpc.ClientConn, error)

NewClient to host for gRPC.

func NewServer

func NewServer(params ServerParams, opts ...grpc.ServerOption) *grpc.Server

NewServer 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. nolint:ireturn

func WithClientConfig

func WithClientConfig(config *Config) ClientOption

WithClientConfig for gRPC. nolint:ireturn

func WithClientDialOption

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

WithClientDialOption for gRPC. nolint:ireturn

func WithClientLogger

func WithClientLogger(logger *zap.Logger) ClientOption

WithClientLogger for gRPC. nolint:ireturn

func WithClientRetry

func WithClientRetry() ClientOption

WithClientRetry for gRPC. nolint:ireturn

func WithClientSecure

func WithClientSecure() ClientOption

WithClientSecure for gRPC. nolint:ireturn

func WithClientStreamInterceptors

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

WithClientUnaryInterceptors for gRPC. nolint:ireturn

func WithClientTracer

func WithClientTracer(tracer opentracing.Tracer) ClientOption

WithClientConfig for gRPC. nolint:ireturn

func WithClientUnaryInterceptors

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

WithClientUnaryInterceptors for gRPC. nolint:ireturn

type Config

type Config struct {
	Port      string       `yaml:"port"`
	UserAgent string       `yaml:"user_agent"`
	Retry     retry.Config `yaml:"retry"`
}

Config for gRPC.

type ServerParams

type ServerParams struct {
	fx.In

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

ServerParams for gRPC.