scheduler

package module

Go to main page

Versions in this module

v0

v0.3.0

Oct 2, 2025

v0.2.3

Oct 1, 2025

Changes in this version

+ var ErrNoPersistenceHandler = errors.New("no persistence handler configured")

+ var ErrUnknownPersistenceBackend = errors.New("unknown persistence backend")

type MemoryJobStore

+ func (s *MemoryJobStore) LoadJobs(handler PersistenceHandler) ([]Job, error)

+ func (s *MemoryJobStore) SaveJobs(jobs []Job, handler PersistenceHandler) error

+ type MemoryPersistenceHandler struct

+ func NewMemoryPersistenceHandler() *MemoryPersistenceHandler

+ func (h *MemoryPersistenceHandler) Clear()

+ func (h *MemoryPersistenceHandler) GetStoredData() []byte

+ func (h *MemoryPersistenceHandler) Load() ([]Job, error)

+ func (h *MemoryPersistenceHandler) Save(jobs []Job) error

type PersistableJobStore

+ LoadJobs func(handler PersistenceHandler) ([]Job, error)

+ SaveJobs func(jobs []Job, handler PersistenceHandler) error

+ type PersistenceBackend string

+ const PersistenceBackendCustom

+ const PersistenceBackendMemory

+ const PersistenceBackendNone

+ type PersistenceHandler interface

+ Load func() ([]Job, error)

+ Save func(jobs []Job) error

type SchedulerConfig

+ PersistenceBackend PersistenceBackend

+ PersistenceHandler PersistenceHandler

v0.2.2

Aug 30, 2025

v0.2.1

Aug 25, 2025

v0.2.0

Aug 20, 2025

Changes in this version

+ const EventTypeConfigLoaded

+ const EventTypeConfigValidated

+ const EventTypeError

+ const EventTypeJobCancelled

+ const EventTypeJobCompleted

+ const EventTypeJobFailed

+ const EventTypeJobRemoved

+ const EventTypeJobScheduled

+ const EventTypeJobStarted

+ const EventTypeModuleStarted

+ const EventTypeModuleStopped

+ const EventTypeSchedulerPaused

+ const EventTypeSchedulerResumed

+ const EventTypeSchedulerStarted

+ const EventTypeSchedulerStopped

+ const EventTypeWarning

+ const EventTypeWorkerBusy

+ const EventTypeWorkerIdle

+ const EventTypeWorkerStarted

+ const EventTypeWorkerStopped

+ var ErrNoSubjectForEventEmission = errors.New("no subject available for event emission")

+ type EventEmitter interface

+ EmitEvent func(ctx context.Context, event cloudevents.Event) error

type SchedulerModule

+ func (m *SchedulerModule) EmitEvent(ctx context.Context, event cloudevents.Event) error

+ func (m *SchedulerModule) GetRegisteredEventTypes() []string

+ func (m *SchedulerModule) RegisterObservers(subject modular.Subject) error

type SchedulerOption

+ func WithEventEmitter(emitter EventEmitter) SchedulerOption

v0.1.1

Aug 11, 2025

Changes in this version

+ var ErrExecutionNotFound = errors.New("execution not found")

+ var ErrJobAlreadyExists = errors.New("job already exists")

+ var ErrJobIDRequired = errors.New("job ID must be provided when resuming a job")

+ var ErrJobInvalidSchedule = errors.New("job must have either RunAt or Schedule specified")

+ var ErrJobMustBeRecurring = errors.New("job must be recurring and have a schedule")

+ var ErrJobNoValidNextRunTime = errors.New("job has no valid next run time")

+ var ErrJobNotFound = errors.New("job not found")

+ var ErrJobStoreNotPersistable = errors.New("job store does not implement PersistableJobStore interface")

+ var ErrNoExecutionsFound = errors.New("no executions found for job")

+ var ErrRecurringJobIDRequired = errors.New("job ID must be provided when resuming a recurring job")

+ var ErrRecurringJobNeedsSchedule = errors.New("recurring jobs must have a Schedule")

+ var ErrSchedulerShutdownTimeout = errors.New("scheduler shutdown timed out")

v0.1.0

Jul 10, 2025

Changes in this version

+ const ModuleName

+ const ServiceName

+ func NewModule() modular.Module

+ type Job struct

+ CreatedAt time.Time

+ ID string

+ IsRecurring bool

+ JobFunc JobFunc

+ LastRun *time.Time

+ Name string

+ NextRun *time.Time

+ RunAt time.Time

+ Schedule string

+ Status JobStatus

+ UpdatedAt time.Time

+ type JobExecution struct

+ EndTime time.Time

+ Error string

+ JobID string

+ StartTime time.Time

+ Status string

+ type JobFunc func(ctx context.Context) error

+ type JobStatus string

+ const JobStatusCancelled

+ const JobStatusCompleted

+ const JobStatusFailed

+ const JobStatusPending

+ const JobStatusRunning

+ type JobStore interface

+ AddJob func(job Job) error

+ AddJobExecution func(execution JobExecution) error

+ CleanupOldExecutions func(before time.Time) error

+ DeleteJob func(jobID string) error

+ GetDueJobs func(before time.Time) ([]Job, error)

+ GetJob func(jobID string) (Job, error)

+ GetJobExecutions func(jobID string) ([]JobExecution, error)

+ GetJobs func() ([]Job, error)

+ GetPendingJobs func() ([]Job, error)

+ UpdateJob func(job Job) error

+ UpdateJobExecution func(execution JobExecution) error

+ type MemoryJobStore struct

+ func NewMemoryJobStore(retentionPeriod time.Duration) *MemoryJobStore

+ func (s *MemoryJobStore) AddJob(job Job) error

+ func (s *MemoryJobStore) AddJobExecution(execution JobExecution) error

+ func (s *MemoryJobStore) CleanupOldExecutions(before time.Time) error

+ func (s *MemoryJobStore) DeleteJob(jobID string) error

+ func (s *MemoryJobStore) GetDueJobs(before time.Time) ([]Job, error)

+ func (s *MemoryJobStore) GetJob(jobID string) (Job, error)

+ func (s *MemoryJobStore) GetJobExecutions(jobID string) ([]JobExecution, error)

+ func (s *MemoryJobStore) GetJobs() ([]Job, error)

+ func (s *MemoryJobStore) GetPendingJobs() ([]Job, error)

+ func (s *MemoryJobStore) LoadFromFile(filePath string) ([]Job, error)

+ func (s *MemoryJobStore) SaveToFile(jobs []Job, filePath string) error

+ func (s *MemoryJobStore) UpdateJob(job Job) error

+ func (s *MemoryJobStore) UpdateJobExecution(execution JobExecution) error

+ type PersistableJobStore interface

+ LoadFromFile func(filePath string) ([]Job, error)

+ SaveToFile func(jobs []Job, filePath string) error

+ type Scheduler struct

+ func NewScheduler(jobStore JobStore, opts ...SchedulerOption) *Scheduler

+ func (s *Scheduler) CancelJob(jobID string) error

+ func (s *Scheduler) GetJob(jobID string) (Job, error)

+ func (s *Scheduler) GetJobHistory(jobID string) ([]JobExecution, error)

+ func (s *Scheduler) ListJobs() ([]Job, error)

+ func (s *Scheduler) ResumeJob(job Job) (string, error)

+ func (s *Scheduler) ResumeRecurringJob(job Job) (string, error)

+ func (s *Scheduler) ScheduleJob(job Job) (string, error)

+ func (s *Scheduler) ScheduleRecurring(name string, cronExpr string, jobFunc JobFunc) (string, error)

+ func (s *Scheduler) Start(ctx context.Context) error

+ func (s *Scheduler) Stop(ctx context.Context) error

+ type SchedulerConfig struct

+ CheckInterval int

+ EnablePersistence bool

+ PersistenceFile string

+ QueueSize int

+ RetentionDays int

+ ShutdownTimeout int

+ StorageType string

+ WorkerCount int

+ type SchedulerModule struct

+ func (m *SchedulerModule) CancelJob(jobID string) error

+ func (m *SchedulerModule) Constructor() modular.ModuleConstructor

+ func (m *SchedulerModule) Dependencies() []string

+ func (m *SchedulerModule) GetJob(jobID string) (Job, error)

+ func (m *SchedulerModule) GetJobHistory(jobID string) ([]JobExecution, error)

+ func (m *SchedulerModule) Init(app modular.Application) error

+ func (m *SchedulerModule) ListJobs() ([]Job, error)

+ func (m *SchedulerModule) Name() string

+ func (m *SchedulerModule) ProvidesServices() []modular.ServiceProvider

+ func (m *SchedulerModule) RegisterConfig(app modular.Application) error

+ func (m *SchedulerModule) RequiresServices() []modular.ServiceDependency

+ func (m *SchedulerModule) ScheduleJob(job Job) (string, error)

+ func (m *SchedulerModule) ScheduleRecurring(name string, cronExpr string, jobFunc JobFunc) (string, error)

+ func (m *SchedulerModule) Start(ctx context.Context) error

+ func (m *SchedulerModule) Stop(ctx context.Context) error

+ type SchedulerOption func(*Scheduler)

+ func WithCheckInterval(interval time.Duration) SchedulerOption

+ func WithLogger(logger modular.Logger) SchedulerOption

+ func WithQueueSize(size int) SchedulerOption

+ func WithWorkerCount(count int) SchedulerOption

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL