core

Documentation

Index

• Constants
• Variables
• func AppendToFile[T any](c chan T, fileName string)
• func BeforeBootup(key string)
• func Clone(original any, target any) error
• func CloseOnlyNotified()
• func Decrypt(key, src []byte) ([]byte, error)
• func Encrypt(key, raw []byte) ([]byte, error)
• func EncryptConfig() error
• func GetContainer() *dig.Container
• func GetService[T any]() T
• func InitConfig(p Bootup) error
• func InitEmbedConfig()
• func InitLogger(p Bootup) (*zap.Logger, error)
• func InvokeAsyncOnServiceStarted(fn any)
• func InvokeOnServiceStarted(fn any)
• func MD5(raw []byte) string
• func NotifyStarted()
• func NotifyStopping()
• func OnEvent(topic string, fn any)
• func OnServiceStarted(fn SystenEvent)
• func OnServiceStopping(fn SystenEvent)
• func PrintVersion()
• func Provide(constructor ...interface{})
• func ProvideStartup(constructor ...any)
• func ReadEncryptConfig(secret []byte, toFile string) error
• func ToEmbedConfig(content []byte, keys ...string)
• func ToMd5(items ...any) string
• type Bootup
• type ChanAdaptor
  • func NewChanAdaptor[T any](buf int) *ChanAdaptor[T]
  • func (ca *ChanAdaptor[T]) Push(data T)
  • func (ca *ChanAdaptor[T]) Start()
  • func (ca *ChanAdaptor[T]) Sub(receiver string) chan T
  • func (ca *ChanAdaptor[T]) Subscripter(receiver string, fn Handler[T])
• type ConfigSecret
• type EmbedConfigReady
• type ErrorReport
• type Handler
• type Md5Value
• 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"
)

Variables

var AppName = "RFID App"

var Bus = EventBus.New()

var ConfigFolder = "config"

var Container = dig.New()

var DefaultFolder = "./data"

var ErrorAdaptor = NewChanAdaptor[ErrorReport](1000) // error adaptor for monitor error.

var StartupOptions = dig.Group("startups")

var Version = "latest"

Functions

func AppendToFile

func AppendToFile[T any](c chan T, fileName string)

func BeforeBootup

func BeforeBootup(key string)

func Clone

func Clone(original any, target any) error

func CloseOnlyNotified

func CloseOnlyNotified()

func Decrypt

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

func Encrypt

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

func EncryptConfig

func EncryptConfig() error

func GetContainer

func GetContainer() *dig.Container

func GetService

func GetService[T any]() T

func InitConfig

func InitConfig(p Bootup) error

func InitEmbedConfig

func InitEmbedConfig()

make sure run it in main before init anything, just make sure, all embed config inited.

func InitLogger

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

func InvokeAsyncOnServiceStarted

func InvokeAsyncOnServiceStarted(fn any)

func InvokeOnServiceStarted

func InvokeOnServiceStarted(fn any)

func MD5

func MD5(raw []byte) string

func NotifyStarted

func NotifyStarted()

func NotifyStopping

func NotifyStopping()

func OnEvent

func OnEvent(topic string, fn any)

func OnServiceStarted

func OnServiceStarted(fn SystenEvent)

OnServiceStarted make sure call this func after

func OnServiceStopping

func OnServiceStopping(fn SystenEvent)

func PrintVersion

func PrintVersion()

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)

func ToMd5

func ToMd5(items ...any) string

Types

type Bootup

type Bootup struct {
	dig.In
	Secret           ConfigSecret
	EmbedConfigReady EmbedConfigReady
}

type ChanAdaptor

type ChanAdaptor[T any] struct {
	Started bool
	// contains filtered or unexported fields
}

Even Bus is good, but can't controll conconcurreny well and performance is not as good as chan, target to replace all eventbus with chanAdaptor.

func NewChanAdaptor

func NewChanAdaptor[T any](buf int) *ChanAdaptor[T]

func (*ChanAdaptor[T]) Push

func (ca *ChanAdaptor[T]) Push(data T)

func (*ChanAdaptor[T]) Start

func (ca *ChanAdaptor[T]) Start()

make sure all receivers reg before start()

func (*ChanAdaptor[T]) Sub

func (ca *ChanAdaptor[T]) Sub(receiver string) chan T

func (*ChanAdaptor[T]) Subscripter

func (ca *ChanAdaptor[T]) Subscripter(receiver string, fn Handler[T])

type ConfigSecret

type ConfigSecret []byte

type EmbedConfigReady

type EmbedConfigReady interface{}

type ErrorReport

type ErrorReport struct {
	Uri       string
	FullStack []byte
	Error     error
}

type Handler

type Handler[T any] func(data T) error

type Md5Value

type Md5Value interface {
	ToMd5() []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()