app

Documentation

Index

• func AddCronJob(spec string, job func())
• type App
  • func NewApp(opts ...Option) *App
  • func (app *App) Bootstrap() *App
  • func (app *App) BootstrapWith(mounters ...ComponentMount) *App
  • func (app *App) RegisterRouter(f ...func(r *gin.Engine)) *App
  • func (app *App) Run() (err error)
  • func (app *App) SetGin(gin *gin.Engine) *App
  • func (app *App) Use(middlewares ...gin.HandlerFunc) *App
  • func (app *App) WaitGracefulExit(srv *http.Server)
• type ComponentMount
• type JobItem
• type Option
• type Options

Functions

func AddCronJob

func AddCronJob(spec string, job func())

AddCronJob use for add job

Types

type App

type App struct {
	*Options
	Gin               *gin.Engine
	Config            *config.Config
	Logger            *logrus.Logger
	Middlewares       []gin.HandlerFunc
	Components        []string
	ComponentMounters []ComponentMount
	RouterRegisters   []func(r *gin.Engine)
	Once              sync.Once
}

App struct

func NewApp

func NewApp(opts ...Option) *App

NewApp return an pointer to App

func (*App) Bootstrap

func (app *App) Bootstrap() *App

Bootstrap use for boot core components

func (*App) BootstrapWith

func (app *App) BootstrapWith(mounters ...ComponentMount) *App

BootstrapWith use for register component

func (*App) RegisterRouter

func (app *App) RegisterRouter(f ...func(r *gin.Engine)) *App

RegisterRouter use for register router

func (*App) Run

func (app *App) Run() (err error)

Run use for run application

func (*App) SetGin

func (app *App) SetGin(gin *gin.Engine) *App

SetGin for inject gin Engin into App

func (*App) Use

func (app *App) Use(middlewares ...gin.HandlerFunc) *App

Use for add global middleware

func (*App) WaitGracefulExit

func (app *App) WaitGracefulExit(srv *http.Server)

WaitGracefulExit graceful exit

type ComponentMount

type ComponentMount func(*App) error

ComponentMount use for mount component interface

type JobItem

type JobItem struct {
	Spec string
	cron.Job
}

Job struct

type Option

type Option func(*Options)

Option use for inject option

type Options

type Options struct {
	Name          string
	Addr          string
	RunMode       string
	CfgCenterAddr string
	CfgCenterPath string
	ShowBanner    bool
	CronEnable    bool
	Cron          *cron.Cron
}

Options struct define app options