mrschedule

Documentation

Index

• type Scheduler
  • func NewScheduler(errorHandler mrcore.ErrorHandler, tasks ...mrworker.Task) *Scheduler
  • func (s *Scheduler) PrepareToStart(ctx context.Context) (execute func() error, interrupt func(error))
  • func (s *Scheduler) Start(ctx context.Context) error
  • func (s *Scheduler) Stop()
• type TaskShell
  • func NewTaskShell(caption string, startup bool, period, timeout time.Duration, ...) *TaskShell
  • func (t *TaskShell) Caption() string
  • func (t *TaskShell) Do(ctx context.Context) error
  • func (t *TaskShell) Period() time.Duration
  • func (t *TaskShell) Startup() bool
  • func (t *TaskShell) Timeout() time.Duration

Types

type Scheduler

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

Scheduler - планировщик задач.

func NewScheduler

func NewScheduler(errorHandler mrcore.ErrorHandler, tasks ...mrworker.Task) *Scheduler

NewScheduler - создаёт объект Scheduler.

func (*Scheduler) PrepareToStart

func (s *Scheduler) PrepareToStart(ctx context.Context) (execute func() error, interrupt func(error))

PrepareToStart - comment method.

func (*Scheduler) Start

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

Start - запуск планировщика задач.

func (*Scheduler) Stop

func (s *Scheduler) Stop()

Stop - остановка планировщика задач.

type TaskShell

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

TaskShell - оболочка реализующая интерфейс mrworker.Task, используемая в планировщике задач, позволяющая вкладывать в себя конкретные задачи.

func NewTaskShell

func NewTaskShell(caption string, startup bool, period, timeout time.Duration, doFunc func(ctx context.Context) error) *TaskShell

NewTaskShell - создаёт объект TaskShell.

func (*TaskShell) Caption

func (t *TaskShell) Caption() string

Caption - возвращает название задачи.

func (*TaskShell) Do

func (t *TaskShell) Do(ctx context.Context) error

Do - исполняет задачу.

func (*TaskShell) Period

func (t *TaskShell) Period() time.Duration

Period - возвращает периодичность запуска задачи.

func (*TaskShell) Startup

func (t *TaskShell) Startup() bool

Startup - необходимо ли стартовать задачу сразу же при инициализации планировщика.

func (*TaskShell) Timeout

func (t *TaskShell) Timeout() time.Duration

Timeout - возвращает таймаут выполнения задачи.