core

Documentation

Index

• Constants
• Variables
• func Decrypt(key, src []byte) ([]byte, error)
• func Encrypt(key, raw []byte) ([]byte, error)
• func EncryptConfig() error
• func GenerateEmbedConfigfile() error
• func GetContainer() *dig.Container
• func Ignored() bool
• func InitConfig(p Bootup) error
• func InitLogger(p Bootup) (*zap.Logger, error)
• func NotifyStarted()
• func NotifyStopping()
• func OnEvent(topic string, fn SystenEvent)
• func OnServiceStarted(fn SystenEvent)
• func OnServiceStopping(fn SystenEvent)
• func Provide(constructor ...interface{})
• func ProvideStartup(constructor ...any)
• func ReadEncryptConfig(secret []byte, toFile string) error
• func ToEmbedConfig(content []byte, keys ...string)
• type Bootup
• type ConfigSecret
• type OptionalParam
• type ServiceParam
• type Startup
• type SystenEvent

Constants

const (
	EventError    = "event.error"
	EventTracing  = "event.tracing"
	EventInit     = "event.gin.inited" //trigger when gin ready to service.
	EventStopping = "event.gin.stopping"
	EventStarted  = "sys.started" //trigger when all inited done.
)

const (
	EncryptedFile = "config/app.cfg"
)

const (
	NO_INIT = "SCM_MUTED"
)

Variables

var AppName = "RFID App"

var Bus = EventBus.New()

var ConfigFolder = "config"

var Container = dig.New()

var EmbedConfigFile = "embed" // for init function can't guarantee embed config be load before startup, so write all content to file.

var StartupOptions = dig.Group("startups")

var Version = "latest"

Functions

func Decrypt

func Decrypt(key, src []byte) ([]byte, error)

func Encrypt

func Encrypt(key, raw []byte) ([]byte, error)

func EncryptConfig

func EncryptConfig() error

func GenerateEmbedConfigfile

func GenerateEmbedConfigfile() error

func GetContainer

func GetContainer() *dig.Container

func Ignored

func Ignored() bool

func InitConfig

func InitConfig(p Bootup) error

func InitLogger

func InitLogger(p Bootup) (*zap.Logger, error)

func NotifyStarted

func NotifyStarted()

func NotifyStopping

func NotifyStopping()

func OnEvent

func OnEvent(topic string, fn SystenEvent)

func OnServiceStarted

func OnServiceStarted(fn SystenEvent)

OnServiceStarted make sure call this func after

func OnServiceStopping

func OnServiceStopping(fn SystenEvent)

func Provide

func Provide(constructor ...interface{})

func ProvideStartup

func ProvideStartup(constructor ...any)

func ReadEncryptConfig

func ReadEncryptConfig(secret []byte, toFile string) error

func ToEmbedConfig

func ToEmbedConfig(content []byte, keys ...string)

Types

type Bootup

type Bootup struct {
	dig.In
	Secret ConfigSecret
}

type ConfigSecret

type ConfigSecret []byte

type OptionalParam

type OptionalParam[T any] struct {
	dig.In
	P T `optional:"true"`
}

type ServiceParam

type ServiceParam struct {
	dig.In
	DB     *gorm.DB
	Logger *zap.Logger
	Bus    EventBus.Bus
}

type Startup

type Startup interface{}

type SystenEvent

type SystenEvent func()