core

type Module interface {
	// Name returns the module name.
	Name() string
	// Group returns the module group.
	Group() string
	// Enable returns the module enabled.
	Enable() bool
	// Start starts the module. This is a runtime function, so error handling is left to the user's control.
	// Normally, you can print the error in the Start() and interrupt the module process with the 'return' keyword.
	// You also can define restart handling by RestartPolicy(), and use panic() to trigger 'OnFailure' restart policy.
	Start()
	// RestartPolicy returns the module's restart policy.
	// If the module does not require a restart policy, return nil.
	RestartPolicy() *ModuleRestartPolicy
}

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

type ModuleRestartPolicy struct {
	// RestartType is the type of restart policy
	RestartType RestartType
	// Retries indicates the number of restarts. If the value is 0, will always restart.
	Retries int32
	// IntervalSecond is the interval seconds between each restart. Default is 1 second.
	IntervalSecond int32
	// IntervalTimeGrowthRate is the growth rate of the time interval between restarts.
	// The value must be greater than 1, otherwise it will be ignored.
	// The interval between each restart is: IntervalTime * IntervalTimeGrowthRate.
	IntervalTimeGrowthRate float64
	// RestartIntervalLimit is the maximum time interval between restarts. Default is 30 seconds.
	RestartIntervalLimit time.Duration
	// ErrorHandler if the Retries is set and reaches the maximum, this method is used to customize error handling.
	// The default handling is to print the error log.
	ErrorHandler func(err error)
}

type RestartType string

type SimpleModule struct {

	// StartFunc indicates the module start function.
	StartFunc func()
	// StartEFunc indicates the module start function that can return an error.
	// The module will panic the error if the function returns an error.
	StartEFunc func() error
	// contains filtered or unexported fields
}

type SimpleModuleOption func(*SimpleModule)

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