server

Documentation

Index

• Variables
• func ClientIP(ctx context.Context) string
• func ClientUserAgent(ctx context.Context) string
• func ErrorFormatter() func(err error) (interface{}, error)
• func HandleBlobs(basePath string, cfg blob.Config, srv *khttp.Server, factory blob.Factory)
• func HandlerWrap[TRet any](resEncoder khttp.EncodeResponseFunc, handler HandlerFunc[TRet]) http.HandlerFunc
• func IsAjax(ctx context.Context) bool
• func IsSecure(ctx context.Context) bool
• func IsWebsocket(ctx context.Context) bool
• func MiddlewareConvert(errEncoder khttp.EncodeErrorFunc, m ...middleware.Middleware) func(handler http.Handler) http.Handler
• func PatchFilter(logger klog.Logger, c *conf.Logging) klog.Logger
• func PatchGrpcOpts(l log.Logger, opts []grpc.ServerOption, name string, services *conf.Services) []grpc.ServerOption
• func PatchHttpOpts(l log.Logger, opts []khttp.ServerOption, name string, services *conf.Services, ...) []khttp.ServerOption
• func ResolveHttpRequest(ctx context.Context) (*http.Request, bool)
• func Saas(hmtOpt *shttp.WebMultiTenancyOption, ts common.TenantStore, ...) middleware.Middleware
• func SetCookie(ctx context.Context, value string) bool
• type DefaultErrorHandler
  • func NewDefaultErrorHandler(errEncoder khttp.EncodeErrorFunc) *DefaultErrorHandler
  • func (e *DefaultErrorHandler) Wrap(f func(w http.ResponseWriter, r *http.Request) error) http.Handler
• type ErrorHandler
• type Handler
• type HandlerFunc

Variables

var (
	ReqDecode  http.DecodeRequestFunc  = http.DefaultRequestDecoder
	ResEncoder http.EncodeResponseFunc = http.DefaultResponseEncoder
	ErrEncoder http.EncodeErrorFunc    = http.DefaultErrorEncoder
)

var DefaultCodecProviderSet = wire.NewSet(wire.Value(ReqDecode), wire.Value(ResEncoder), wire.Value(ErrEncoder),
	NewDefaultErrorHandler, wire.Bind(new(ErrorHandler), new(*DefaultErrorHandler)))

Functions

func ClientIP

func ClientIP(ctx context.Context) string

func ClientUserAgent

func ClientUserAgent(ctx context.Context) string

func ErrorFormatter

func ErrorFormatter() func(err error) (interface{}, error)

func HandleBlobs

func HandleBlobs(basePath string, cfg blob.Config, srv *khttp.Server, factory blob.Factory)

func HandlerWrap

func HandlerWrap[TRet any](resEncoder khttp.EncodeResponseFunc, handler HandlerFunc[TRet]) http.HandlerFunc

func IsAjax

func IsAjax(ctx context.Context) bool

func IsSecure

func IsSecure(ctx context.Context) bool

func IsWebsocket

func IsWebsocket(ctx context.Context) bool

func MiddlewareConvert

func MiddlewareConvert(errEncoder khttp.EncodeErrorFunc, m ...middleware.Middleware) func(handler http.Handler) http.Handler

func PatchFilter

func PatchFilter(logger klog.Logger, c *conf.Logging) klog.Logger

func PatchGrpcOpts

func PatchGrpcOpts(l log.Logger, opts []grpc.ServerOption, name string, services *conf.Services) []grpc.ServerOption

PatchGrpcOpts Patch grpc options with given service name and configs

func PatchHttpOpts

func PatchHttpOpts(l log.Logger,
	opts []khttp.ServerOption,
	name string,
	services *conf.Services,
	sCfg *conf.Security,
	reqDecoder khttp.DecodeRequestFunc,
	resEncoder khttp.EncodeResponseFunc,
	errEncoder khttp.EncodeErrorFunc,
	f ...khttp.FilterFunc) []khttp.ServerOption

PatchHttpOpts Patch khttp options with given service name and configs. f use global filters

func ResolveHttpRequest

func ResolveHttpRequest(ctx context.Context) (*http.Request, bool)

func Saas

func Saas(hmtOpt *shttp.WebMultiTenancyOption, ts common.TenantStore, trustedContextValidator api.TrustedContextValidator, options ...common.PatchTenantResolveOption) middleware.Middleware

func SetCookie

func SetCookie(ctx context.Context, value string) bool

Types

type DefaultErrorHandler

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

func NewDefaultErrorHandler

func NewDefaultErrorHandler(errEncoder khttp.EncodeErrorFunc) *DefaultErrorHandler

func (*DefaultErrorHandler) Wrap

func (e *DefaultErrorHandler) Wrap(f func(w http.ResponseWriter, r *http.Request) error) http.Handler

type ErrorHandler

type ErrorHandler interface {
	Wrap(func(w http.ResponseWriter, r *http.Request) error) http.Handler
}

type Handler

type Handler[TRet any] interface {
	ServeHTTP(w http.ResponseWriter, r *http.Request) (TRet, error)
}

type HandlerFunc

type HandlerFunc[TRet any] func(w http.ResponseWriter, r *http.Request) (TRet, error)