webserver

Oct 12, 2024

Changes in this version

type Factory

+ func (f *Factory) DialOptions(opts ...grpc.DialOption) []grpc.DialOption

+ func (f *Factory) HttpHandlerDecorators(decorators ...http_.HandlerDecorator) []http_.HandlerDecorator

+ func (f *Factory) ServeMuxOptions(opts ...runtime.ServeMuxOption) []runtime.ServeMuxOption

+ func (f *Factory) ServerOptions(opts ...grpc.ServerOption) []grpc.ServerOption

+ func (f *Factory) StreamClientInterceptors(interceptors ...grpc.StreamClientInterceptor) []grpc.StreamClientInterceptor

+ func (f *Factory) StreamServerInterceptors(interceptors ...grpc.StreamServerInterceptor) []grpc.StreamServerInterceptor

+ func (f *Factory) UnaryClientInterceptors(interceptors ...grpc.UnaryClientInterceptor) []grpc.UnaryClientInterceptor

+ func (f *Factory) UnaryHandlers(handlers ...grpc_.UnaryHandlerDecorator) []grpc_.UnaryHandlerDecorator

+ func (f *Factory) UnaryServerInterceptors(interceptors ...grpc.UnaryServerInterceptor) []grpc.UnaryServerInterceptor

type FactoryConfig

+ FillRequestId bool

+ OtelHandling bool

+ StatsHandling bool

+ Validator *validator.Validate

Dec 27, 2023

Changes in this version

type WebServer

+ func (s *WebServer) AddBootSequencePostStartHook(name string, hook PostStartHookFunc) error

+ func (s *WebServer) AddBootSequencePreShutdownHook(name string, hook PreShutdownHookFunc) error

Aug 31, 2023

Changes in this version

+ func GinLogFormatter(layout string) func(param gin.LogFormatterParams) string

Nov 28, 2022

Changes in this version

type WebServer

+ PreferRegisterHTTPFromEndpoint bool

Nov 28, 2022

Changes in this version

type FactoryConfig

+ PreferRegisterHTTPFromEndpoint bool

Jun 17, 2022

Changes in this version

+ func GinMuxer(muxer gin.IRouter) healthz.Muxer

+ type CertKey struct

+ Cert string

+ Key string

+ type Factory struct

+ func NewFactory(fc FactoryConfig, configs ...FactoryConfigFunc) (Factory, error)

+ func (f *Factory) GetBackendBindHostPort() string

+ func (f *Factory) GetBackendExternalHostPort() string

+ func (f *Factory) GetBackendServeHostPort(external bool) string

+ func (f *Factory) HTTPScheme() string

+ func (f *Factory) ResolveBackendLocalUrl(relativePaths ...string) string

+ func (f *Factory) ResolveLocalIp() string

+ func (f Factory) Config() FactoryConfig

+ func (f Factory) New() (*WebServer, error)

+ type FactoryConfig struct

+ BindAddress string

+ BurstLimitTimeoutStream time.Duration

+ BurstLimitTimeoutUnary time.Duration

+ Cors cors.Options

+ EnableLogrusMiddleware bool

+ ExternalAddress string

+ ForceDisableTls bool

+ GatewayOptions []grpc_.GatewayOption

+ GinMiddlewares []gin.HandlerFunc

+ HandledTimeoutStream time.Duration

+ HandledTimeoutUnary time.Duration

+ LocalIpResolver *LocalIpResolver

+ MaxConcurrencyStream int

+ MaxConcurrencyUnary int

+ MaxReceiveMessageSizeInBytes int

+ MaxSendMessageSizeInBytes int

+ Name string

+ NoGrpcProxy bool

+ ShutdownDelayDuration time.Duration

+ TlsConfig *tls.Config

+ func (fc *FactoryConfig) SetDefaults()

+ func (fc FactoryConfig) Validate() error

+ type FactoryConfigFunc func(os *FactoryConfig) error

+ type LocalIpResolver struct

+ Addresses []string

+ Networks []string

+ Timeout time.Duration

+ type Net struct

+ Domains []string

+ Host string

+ Port int32

+ type PostStartHookFunc func(ctx context.Context) error

+ type PostStartHookProvider interface

+ PostStartHook func() (string, PostStartHookFunc, error)

+ type PreShutdownHookFunc func() error

+ type TLS struct

+ AllowedTlsCidrs []string

+ Enable bool

+ KeyPairBase64 *CertKey

+ KeyPairPath *CertKey

+ ServiceName string

+ WhitelistedPaths []string

+ type WebHandler interface

+ SetRoutes func(ginRouter gin.IRouter, grpcRouter *grpc.Gateway)

+ type WebServer struct

+ BindAddress string

+ ExternalAddress string

+ Name string

+ ShutdownDelayDuration time.Duration

+ ShutdownTimeout time.Duration

+ func NewWebServer(fc FactoryConfig, configs ...FactoryConfigFunc) (*WebServer, error)

+ func (s *WebServer) AddBootSequenceHealthChecks(checks ...healthz.HealthChecker) error

+ func (s *WebServer) AddHealthChecks(checks ...healthz.HealthChecker) error

+ func (s *WebServer) AddPostStartHook(name string, hook PostStartHookFunc) error

+ func (s *WebServer) AddPostStartHookOrDie(name string, hook PostStartHookFunc)

+ func (s *WebServer) AddPreShutdownHook(name string, hook PreShutdownHookFunc) error

+ func (s *WebServer) AddPreShutdownHookOrDie(name string, hook PreShutdownHookFunc)

+ func (s *WebServer) InstallWebHandlers(handlers ...WebHandler)

+ func (s *WebServer) PrepareRun() (preparedWebServer, error)

+ func (s *WebServer) RunPostStartHooks(ctx context.Context)

+ func (s *WebServer) RunPreShutdownHooks() error