confxxl

type Endpoint struct {
	types.Endpoint[Option]
	// contains filtered or unexported fields
}

type Error int8

type Executor interface {
	// Register registers a job of `name` with handler `j` to Executor
	Register(name string, j JobHandler) error
	// Kill kills a job by job id
	Kill(int64) error
	// Do execute schedule once with job `name` and trigger data `t`
	Do(t *TriggerRequest) error
	// Close closes executor
	Close() error
	// RefreshActivity refreshes last heartbeat request time from xxl-job
	RefreshActivity()
	// IsActive reports if this Executor is enabled in xxl-job service
	IsActive() bool
	// IsIdle check idle status by job ID.
	IsIdle(int64) bool
}

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

type ExecutorOptionApplier func(*ExecutorOption)

type IdleBeatRequest struct {
	JobID int64 `json:"jobID"`
}

type JobCallback func(*TriggerRequest, error)

type JobHandler func(context.Context, *TriggerRequest) error

type JobManager interface {
	// Register registers a job with name, job handler h and option appliers.
	// It starts scheduler of this job.
	Register(name string, h JobHandler, appliers ...JobOptionApplier) error
	// Unregister unregisters job by name and releases scheduler.
	Unregister(name string) error
	// Schedule does once schedule.
	// The result can be retrieved by JobCallback, if it is configurated when Register
	Schedule(context.Context, string, *TriggerRequest) error
	// IsIdle return if job is during scheduling
	IsIdle(name string) bool
	// Close closes all registered Scheduler.
	Close() error
}

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

type JobOptionApplier func(*JobOption)

type KillJobRequest struct {
	JobID int64 `json:"jobID"`
}

type Option struct {
	ClientID string
	// Listener denotes local exposed address. this address reports to xxl-job
	// service for accepting trigger request from xxl-job
	Listener string `url:""`
	// AccessToken xxl-job request access token
	AccessToken string `url:""`
	// KeepAlive heartbeat interval for executors
	KeepAlive types.Duration `url:",default=30s"`
	// ClientTimeout heartbeat interval for executors
	ClientTimeout types.Duration `url:",default=5s"`
	// DisableDebugLog if disable debug log
	DisableDebugLog bool `url:",default=false"`
	// MaxBacklogs denotes max backlogs per job. if job trigger parameter use
	// enums.BLOCK_STRATEGY__SERIAL_EXECUTION mode it may cause backlogs.
	// when backlogs reached this limitation the trigger will be callback with
	// ERROR__JOB_REACH_MAX_BACKLOG error
	MaxBacklogs int `url:",default=10"`
	// Executor registered executor list
	Executor []string
}

type Registry interface {
	Close() error

	RegisterJob(executor string, job string, fn JobHandler) error
	IsActive(executor string) bool
}

type Task interface {
	// Name denotes Task name
	Name() string
	// Close stops job scheduling
	Close() error
	// Push appends a task for scheduling
	Push(context.Context, *TriggerRequest) error
	// Pending returns pending task count
	Pending() int
	// Scheduling returns scheduling task count
	Scheduling() int
	// SkipPreviousAndPush appending task after skip previous tasks
	SkipPreviousAndPush(ctx context.Context, r *TriggerRequest) error
	// PushIfIdle appending task if current scheduler is idle
	PushIfIdle(ctx context.Context, r *TriggerRequest) error
}

type TriggerRequest struct {
	// JobID 任务ID
	JobID int64 `json:"jobId"`
	// ExecutorHandler 任务标识
	ExecutorHandler string `json:"executorHandler"`
	// ExecutorParams 任务参数
	ExecutorParams string `json:"executorParams"`
	// ExecutorBlockStrategy 任务阻塞策略
	ExecutorBlockStrategy enums.BlockStrategy `json:"executorBlockStrategy"`
	// ExecutorTimeout 任务超时时间(秒,大于零生效)
	ExecutorTimeout int64 `json:"executorTimeout"`
	// LogID 本次调度日志ID
	LogID int64 `json:"logId"`
	// LogDateTime 本次调度日志时间
	LogDateTime int64 `json:"logDateTime"`
	// GlueType 任务模式
	GlueType enums.GlueType `json:"glueType"`
	// GlueSource GLUE脚本代码
	GlueSource string `json:"glueSource"`
	// GlueUpdateTime GLUE脚本更新时间，用于判定脚本是否变更以及是否需要刷新
	GlueUpdateTime int64 `json:"glueUpdatetime"`
	// BroadcastIndex 当前分片
	BroadcastIndex int64 `json:"broadcastIndex"`
	// BroadcastTotal 总分片
	BroadcastTotal int64 `json:"broadcastTotal"`
}