schedulermgr

Documentation

Index

• type CronConfig
• type ISchedulerManager
  • func Build(config *CronConfig, loggerMgr loggermgr.ILoggerManager) (ISchedulerManager, error)
  • func BuildWithConfigProvider(configProvider configmgr.IConfigManager, loggerMgr loggermgr.ILoggerManager) (ISchedulerManager, error)
  • func NewSchedulerManagerCronImpl(config *CronConfig, loggerMgr loggermgr.ILoggerManager) ISchedulerManager

Types

type CronConfig

type CronConfig struct {
	ValidateOnStartup bool `yaml:"validate_on_startup"` // 启动时是否检查所有 Scheduler 配置
}

CronConfig Crontab 定时器配置

type ISchedulerManager

type ISchedulerManager interface {
	common.IBaseManager

	// ValidateScheduler 验证定时器配置是否正确
	// 在程序加载时调用，配置错误直接 panic
	// scheduler: 待验证的定时器实例
	// 返回: 验证错误（调用方负责 panic）
	ValidateScheduler(scheduler common.IBaseScheduler) error

	// RegisterScheduler 注册定时器
	// 在 SchedulerManager.OnStart() 时由容器调用
	// scheduler: 待注册的定时器实例
	// 返回: 注册错误
	RegisterScheduler(scheduler common.IBaseScheduler) error

	// UnregisterScheduler 注销定时器
	// 在 SchedulerManager.OnStop() 时由容器调用
	// scheduler: 待注销的定时器实例
	// 返回: 注销错误
	UnregisterScheduler(scheduler common.IBaseScheduler) error
}

ISchedulerManager 定时任务管理器接口

func Build

func Build(
	config *CronConfig,
	loggerMgr loggermgr.ILoggerManager,
) (ISchedulerManager, error)

Build 创建调度管理器实例 参数：

• config: Cron 配置
• loggerMgr: 日志管理器

func BuildWithConfigProvider

func BuildWithConfigProvider(
	configProvider configmgr.IConfigManager,
	loggerMgr loggermgr.ILoggerManager,
) (ISchedulerManager, error)

BuildWithConfigProvider 从配置提供者创建调度管理器实例 自动从配置提供者读取 scheduler.driver 和 cron_config 参数：

• configProvider: 配置提供者
• loggerMgr: 日志管理器

func NewSchedulerManagerCronImpl

func NewSchedulerManagerCronImpl(
	config *CronConfig,
	loggerMgr loggermgr.ILoggerManager,
) ISchedulerManager

NewSchedulerManagerCronImpl 创建 Cron 实现的调度管理器 参数：

• config: Cron 配置
• loggerMgr: 日志管理器