gosched

README

go-sched

the idea is based on this article

TODO

• Implement basic functionality
  • generic min heap
  • task worker
  • task group manager
  • scheduling
  • add test
• Add cron-like interface
• Add task cancelling functionality
• Add task store and restore-after-reboot functionality
• Refactoring
• Add detailed careful test.

Architecture

simplified architecture

Documentation

Index

• func NewSchedulerWrapper(s *scheduler.Scheduler) (*SchedulerCronWrapper, *SchedulerTaskMapWrapper)
• func SimpleCommandFactory(command []string) cron.WorkFn
• type CommandFactory
  • func NewCommandFactory(keyword string, workRegistry *WorkRegistry) *CommandFactory
  • func (cf *CommandFactory) Build(command []string) cron.WorkFn
• type Logger
• type MopLogger
  • func (l *MopLogger) Debugw(msg string, args ...interface{})
  • func (l *MopLogger) Errorw(msg string, args ...interface{})
  • func (l *MopLogger) Fatalw(msg string, args ...interface{})
  • func (l *MopLogger) Infow(msg string, args ...interface{})
  • func (l *MopLogger) Warnw(msg string, args ...interface{})
  • func (l *MopLogger) With(args ...interface{}) Logger
• type SchedulerCronWrapper
  • func NewWrapperForCron(s *scheduler.Scheduler) *SchedulerCronWrapper
  • func (w *SchedulerCronWrapper) SchedTask(targetTime time.Time, work func(scheduled, current time.Time)) (cron.Task, error)
• type SchedulerTaskMapWrapper
  • func NewWrapperForTaskMap(s *scheduler.Scheduler) *SchedulerTaskMapWrapper
  • func (w *SchedulerTaskMapWrapper) SchedTask(targetTime time.Time, work func(scheduled, current time.Time)) (storagewrapper.Task, error)
• type WorkFnWrapperFactory
  • func (c *WorkFnWrapperFactory) Build() cron.WorkFnWrapper
• type WorkFnWrapperFactoryBuilder
  • func NewCommandFactoryBuilder() WorkFnWrapperFactoryBuilder
  • func (b WorkFnWrapperFactoryBuilder) Build() WorkFnWrapperFactory
  • func (b WorkFnWrapperFactoryBuilder) Deadline(deadline time.Duration) WorkFnWrapperFactoryBuilder
  • func (b WorkFnWrapperFactoryBuilder) Logger(l Logger) WorkFnWrapperFactoryBuilder
  • func (b WorkFnWrapperFactoryBuilder) Repeat(repeat int) WorkFnWrapperFactoryBuilder
  • func (b WorkFnWrapperFactoryBuilder) ReschedOnDeadline(reschedOnDeadline bool) WorkFnWrapperFactoryBuilder
  • func (b WorkFnWrapperFactoryBuilder) ShouldResched(shouldResched func(err error, repeat int) bool) WorkFnWrapperFactoryBuilder
• type WorkRegistry
  • func NewWorkRegistry() *WorkRegistry
  • func (m *WorkRegistry) Delete(key string)
  • func (m *WorkRegistry) Load(key string) (value func(scheduled, current time.Time, params any) error, ok bool)
  • func (m *WorkRegistry) LoadAndDelete(key string) (value func(scheduled, current time.Time, params any) error, loaded bool)
  • func (m *WorkRegistry) LoadOrStore(key string, value func(scheduled, current time.Time, params any) error) (actual func(scheduled, current time.Time, params any) error, loaded bool)
  • func (m *WorkRegistry) Range(...)
  • func (m *WorkRegistry) Store(key string, value func(scheduled, current time.Time, params any) error)
• type ZapLogger
  • func NewZapLogger(z *zap.SugaredLogger) *ZapLogger
  • func (l *ZapLogger) Debugw(msg string, args ...interface{})
  • func (l *ZapLogger) Errorw(msg string, args ...interface{})
  • func (l *ZapLogger) Fatalw(msg string, args ...interface{})
  • func (l *ZapLogger) Infow(msg string, args ...interface{})
  • func (l *ZapLogger) Warnw(msg string, args ...interface{})
  • func (l *ZapLogger) With(args ...interface{}) Logger

Functions

func NewSchedulerWrapper

func NewSchedulerWrapper(s *scheduler.Scheduler) (*SchedulerCronWrapper, *SchedulerTaskMapWrapper)

func SimpleCommandFactory

func SimpleCommandFactory(command []string) cron.WorkFn

SimpleCommandFactory builds []string into blocking cli command call. First return value is []byte, output result of command. Usually it is mere text.

Invariants: Command must have 1 or more elements. first must be executable name.

Types

type CommandFactory

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

func NewCommandFactory

func NewCommandFactory(keyword string, workRegistry *WorkRegistry) *CommandFactory

func (*CommandFactory) Build

func (cf *CommandFactory) Build(command []string) cron.WorkFn

type Logger

type Logger interface {
	With(args ...interface{}) Logger
	Debugw(msg string, args ...interface{})
	Infow(msg string, args ...interface{})
	Warnw(msg string, args ...interface{})
	Errorw(msg string, args ...interface{})
	Fatalw(msg string, args ...interface{})
}

type MopLogger

type MopLogger struct{}

func (*MopLogger) Debugw

func (l *MopLogger) Debugw(msg string, args ...interface{})

func (*MopLogger) Errorw

func (l *MopLogger) Errorw(msg string, args ...interface{})

func (*MopLogger) Fatalw

func (l *MopLogger) Fatalw(msg string, args ...interface{})

func (*MopLogger) Infow

func (l *MopLogger) Infow(msg string, args ...interface{})

func (*MopLogger) Warnw

func (l *MopLogger) Warnw(msg string, args ...interface{})

func (*MopLogger) With

func (l *MopLogger) With(args ...interface{}) Logger

type SchedulerCronWrapper

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

func NewWrapperForCron

func NewWrapperForCron(s *scheduler.Scheduler) *SchedulerCronWrapper

func (*SchedulerCronWrapper) SchedTask

func (w *SchedulerCronWrapper) SchedTask(targetTime time.Time, work func(scheduled, current time.Time)) (cron.Task, error)

type SchedulerTaskMapWrapper

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

func NewWrapperForTaskMap

func NewWrapperForTaskMap(s *scheduler.Scheduler) *SchedulerTaskMapWrapper

func (*SchedulerTaskMapWrapper) SchedTask

func (w *SchedulerTaskMapWrapper) SchedTask(targetTime time.Time, work func(scheduled, current time.Time)) (storagewrapper.Task, error)

type WorkFnWrapperFactory

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

func (*WorkFnWrapperFactory) Build

func (c *WorkFnWrapperFactory) Build() cron.WorkFnWrapper

type WorkFnWrapperFactoryBuilder

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

func NewCommandFactoryBuilder

func NewCommandFactoryBuilder() WorkFnWrapperFactoryBuilder

func (WorkFnWrapperFactoryBuilder) Build

func (b WorkFnWrapperFactoryBuilder) Build() WorkFnWrapperFactory

func (WorkFnWrapperFactoryBuilder) Deadline

func (b WorkFnWrapperFactoryBuilder) Deadline(deadline time.Duration) WorkFnWrapperFactoryBuilder

func (WorkFnWrapperFactoryBuilder) Logger

func (b WorkFnWrapperFactoryBuilder) Logger(l Logger) WorkFnWrapperFactoryBuilder

func (WorkFnWrapperFactoryBuilder) Repeat

func (b WorkFnWrapperFactoryBuilder) Repeat(repeat int) WorkFnWrapperFactoryBuilder

func (WorkFnWrapperFactoryBuilder) ReschedOnDeadline

func (b WorkFnWrapperFactoryBuilder) ReschedOnDeadline(reschedOnDeadline bool) WorkFnWrapperFactoryBuilder

func (WorkFnWrapperFactoryBuilder) ShouldResched

func (b WorkFnWrapperFactoryBuilder) ShouldResched(shouldResched func(err error, repeat int) bool) WorkFnWrapperFactoryBuilder

type WorkRegistry

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

func NewWorkRegistry

func NewWorkRegistry() *WorkRegistry

func (*WorkRegistry) Delete

func (m *WorkRegistry) Delete(key string)

func (*WorkRegistry) Load

func (m *WorkRegistry) Load(key string) (value func(scheduled, current time.Time, params any) error, ok bool)

func (*WorkRegistry) LoadAndDelete

func (m *WorkRegistry) LoadAndDelete(key string) (value func(scheduled, current time.Time, params any) error, loaded bool)

func (*WorkRegistry) LoadOrStore

func (m *WorkRegistry) LoadOrStore(key string, value func(scheduled, current time.Time, params any) error) (actual func(scheduled, current time.Time, params any) error, loaded bool)

func (*WorkRegistry) Range

func (m *WorkRegistry) Range(f func(key string, value func(scheduled, current time.Time, params any) error) bool)

func (*WorkRegistry) Store

func (m *WorkRegistry) Store(key string, value func(scheduled, current time.Time, params any) error)

type ZapLogger

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

func NewZapLogger

func NewZapLogger(z *zap.SugaredLogger) *ZapLogger

func (*ZapLogger) Debugw

func (l *ZapLogger) Debugw(msg string, args ...interface{})

func (*ZapLogger) Errorw

func (l *ZapLogger) Errorw(msg string, args ...interface{})

func (*ZapLogger) Fatalw

func (l *ZapLogger) Fatalw(msg string, args ...interface{})

func (*ZapLogger) Infow

func (l *ZapLogger) Infow(msg string, args ...interface{})

func (*ZapLogger) Warnw

func (l *ZapLogger) Warnw(msg string, args ...interface{})

func (*ZapLogger) With

func (l *ZapLogger) With(args ...interface{}) Logger