fxgrpc

Documentation

Index

• func RunHTTPGateway(lc fx.Lifecycle, s fx.Shutdowner, logger *zap.Logger, config *Config, ...) error
• func RunHealthServer(lc fx.Lifecycle, s fx.Shutdowner, config *Config, logger *zap.Logger, ...)
• func RunLivenessGateway(lc fx.Lifecycle, s fx.Shutdowner, logger *zap.Logger, config *Config, ...) error
• func RunRegisteredGRPCServer(lc fx.Lifecycle, s fx.Shutdowner, logger *zap.Logger, gs *GRPCServer)
• type Config
• type GRPCConfig
• type GRPCServer
• type HTTPGatewayConfig
• type HTTPGatewayHandler
• type HealthConfig
• type LivenessGatewayConfig
• type LivenessGatewayHandler

Functions

func RunHTTPGateway

func RunHTTPGateway(lc fx.Lifecycle, s fx.Shutdowner, logger *zap.Logger, config *Config, g *HTTPGatewayHandler) error

func RunHealthServer

func RunHealthServer(lc fx.Lifecycle, s fx.Shutdowner, config *Config, logger *zap.Logger, sn toolkitfx.ServiceName)

func RunLivenessGateway

func RunLivenessGateway(lc fx.Lifecycle, s fx.Shutdowner, logger *zap.Logger, config *Config, h *LivenessGatewayHandler) error

func RunRegisteredGRPCServer

func RunRegisteredGRPCServer(lc fx.Lifecycle, s fx.Shutdowner, logger *zap.Logger, gs *GRPCServer)

Types

type Config

type Config struct {
	GRPC            GRPCConfig
	Health          HealthConfig
	HTTPGateway     HTTPGatewayConfig
	LivenessGateway LivenessGatewayConfig
}

type GRPCConfig

type GRPCConfig struct {
	Host                                    string        `default:"0.0.0.0"`
	Port                                    string        `default:"8080"`
	MaxConnectionAge                        time.Duration `default:"5m"`
	KeepAliveEnforcementMinTime             time.Duration `default:"1m"`
	KeepAliveEnforcementPermitWithoutStream bool          `default:"true"`
}

type GRPCServer

type GRPCServer struct {
	Server *grpcutils.Server
}

type HTTPGatewayConfig

type HTTPGatewayConfig struct {
	Host string `default:"0.0.0.0"`
	Port string `default:"9090"`
}

type HTTPGatewayHandler

type HTTPGatewayHandler struct {
	Handler func(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
}

type HealthConfig

type HealthConfig struct {
	Enabled bool   `default:"true"`
	Host    string `default:"0.0.0.0"`
	Port    string `default:"10010"`
}

type LivenessGatewayConfig

type LivenessGatewayConfig struct {
	Host string `default:"0.0.0.0"`
	Port string `default:"8086"`
}

type LivenessGatewayHandler

type LivenessGatewayHandler struct {
	Handler http.Handler
}