beans

Documentation

Index

• func GinLogger(log *nlog.NLog, ginName string) gin.HandlerFunc
• type GinBean
  • func (b *GinBean) Init(e framework.ConfBeanRegistry) error
  • func (b *GinBean) RegisterGroup(groupRouters *router.GroupRouters)
  • func (b *GinBean) RegisterRouter(router *router.Router)
  • func (b *GinBean) Start(ctx context.Context, e framework.ConfBeanRegistry) error
  • func (b *GinBean) Validate(errs *errorcode.Errs)
• type GinBeanConfig
• type MetricsBean
  • func (b *MetricsBean) Init(e framework.ConfBeanRegistry) error
  • func (b *MetricsBean) Start(ctx context.Context, e framework.ConfBeanRegistry) error
  • func (b *MetricsBean) Validate(errs *errorcode.Errs)
• type TLSServerConfig

Functions

func GinLogger

func GinLogger(log *nlog.NLog, ginName string) gin.HandlerFunc

Types

type GinBean

type GinBean struct {
	framework.ConfigLoader
	// Configs
	IP      string `name:"ip" usage:"Server bind ip" default:"0.0.0.0"`
	Port    int    `name:"port" usage:"Server port" default:"8080"`
	Debug   bool   `name:"debug" usage:"Debug mode"`
	LogPath string `name:"logpath" usage:"Gin Log path"`
	GinBeanConfig
	*gin.Engine
}

func (*GinBean) Init

func (b *GinBean) Init(e framework.ConfBeanRegistry) error

func (*GinBean) RegisterGroup

func (b *GinBean) RegisterGroup(groupRouters *router.GroupRouters)

func (*GinBean) RegisterRouter

func (b *GinBean) RegisterRouter(router *router.Router)

func (*GinBean) Start

func (b *GinBean) Start(ctx context.Context, e framework.ConfBeanRegistry) error

func (*GinBean) Validate

func (b *GinBean) Validate(errs *errorcode.Errs)

type GinBeanConfig

type GinBeanConfig struct {
	Logger          *nlog.NLog
	ReadTimeout     *int
	WriteTimeout    *int
	IdleTimeout     *int
	MaxHeaderBytes  *int
	TLSServerConfig *TLSServerConfig
}

type MetricsBean

type MetricsBean struct {
	framework.ConfigLoader
	// Configs
	Port   int  `name:"port" usage:"Metrics port - use default gin port when not set"`
	Enable bool `name:"enable" usage:"Metrics enable" default:"true"`
	// contains filtered or unexported fields
}

func (*MetricsBean) Init

func (b *MetricsBean) Init(e framework.ConfBeanRegistry) error

func (*MetricsBean) Start

func (b *MetricsBean) Start(ctx context.Context, e framework.ConfBeanRegistry) error

func (*MetricsBean) Validate

func (b *MetricsBean) Validate(errs *errorcode.Errs)

type TLSServerConfig

type TLSServerConfig struct {
	CACert     *x509.Certificate
	ServerCert *x509.Certificate
	ServerKey  *rsa.PrivateKey
}