grpc

Documentation

Index

• Variables
• type GrpcClient
  • func NewGrpcClient(config *config.GrpcOptions) (GrpcClient, error)
• type GrpcServer
  • func NewGrpcServer(config *config.GrpcOptions, logger logger.Logger, meter metric.Meter) GrpcServer
• type GrpcServiceBuilder
  • func NewGrpcServiceBuilder(server *grpc.Server) *GrpcServiceBuilder
  • func (r *GrpcServiceBuilder) Build() *grpc.Server
  • func (r *GrpcServiceBuilder) RegisterRoutes(builder func(s *grpc.Server)) *GrpcServiceBuilder

Variables

var (
	// Module provided to fxlog
	// https://uber-go.github.io/fx/modules.html
	Module = fx.Module("grpcfx", grpcProviders, grpcInvokes) //nolint:gochecknoglobals

)

Types

type GrpcClient

type GrpcClient interface {
	GetGrpcConnection() *grpc.ClientConn
	Close() error
	// WaitForAvailableConnection waiting for grpc endpoint becomes ready in the given timeout
	WaitForAvailableConnection() error
}

func NewGrpcClient

func NewGrpcClient(config *config.GrpcOptions) (GrpcClient, error)

type GrpcServer

type GrpcServer interface {
	RunGrpcServer(configGrpc ...func(grpcServer *googleGrpc.Server)) error
	GracefulShutdown()
	GetCurrentGrpcServer() *googleGrpc.Server
	GrpcServiceBuilder() *GrpcServiceBuilder
}

func NewGrpcServer

func NewGrpcServer(
	config *config.GrpcOptions,
	logger logger.Logger,
	meter metric.Meter,
) GrpcServer

type GrpcServiceBuilder

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

func NewGrpcServiceBuilder

func NewGrpcServiceBuilder(server *grpc.Server) *GrpcServiceBuilder

func (*GrpcServiceBuilder) Build

func (r *GrpcServiceBuilder) Build() *grpc.Server

func (*GrpcServiceBuilder) RegisterRoutes

func (r *GrpcServiceBuilder) RegisterRoutes(builder func(s *grpc.Server)) *GrpcServiceBuilder