schedule

Documentation

Index

• Variables
• type Option
  • func WithCaption(value string) Option
  • func WithCaptionPrefix(value string) Option
  • func WithReadyTimeout(value time.Duration) Option
  • func WithTasks(values ...mrworker.Task) Option
• type TaskScheduler
  • func NewTaskScheduler(errorHandler mrcore.ErrorHandler, logger mrlog.Logger, ...) *TaskScheduler
  • func (s *TaskScheduler) Caption() string
  • func (s *TaskScheduler) ReadyTimeout() time.Duration
  • func (s *TaskScheduler) Shutdown(ctx context.Context) error
  • func (s *TaskScheduler) Start(ctx context.Context, ready func()) error

Variables

var (
	// ErrInternalNoTasks - comment var.
	ErrInternalNoTasks = mrerr.NewKindInternal("no tasks to start for the task scheduler")

	// ErrInternalZeroParam - comment var.
	ErrInternalZeroParam = mrerr.NewKindInternal("task has zero param for the task scheduler: {ParamName}")
)

Types

type Option

type Option func(o *options)

Option - настройка объекта TaskScheduler.

func WithCaption

func WithCaption(value string) Option

WithCaption - устанавливает опцию caption для TaskScheduler.

func WithCaptionPrefix

func WithCaptionPrefix(value string) Option

WithCaptionPrefix - устанавливает опцию caption для TaskScheduler.

func WithReadyTimeout

func WithReadyTimeout(value time.Duration) Option

WithReadyTimeout - устанавливает опцию readyTimeout для TaskScheduler.

func WithTasks

func WithTasks(values ...mrworker.Task) Option

WithTasks - устанавливает опцию tasks для TaskScheduler.

type TaskScheduler

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

TaskScheduler - многопоточный сервис запуска задач по расписанию (планировщик задач).

func NewTaskScheduler

func NewTaskScheduler(errorHandler mrcore.ErrorHandler, logger mrlog.Logger, traceManager traceManager, opts ...Option) *TaskScheduler

NewTaskScheduler - создаёт объект TaskScheduler.

func (*TaskScheduler) Caption

func (s *TaskScheduler) Caption() string

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

func (*TaskScheduler) ReadyTimeout

func (s *TaskScheduler) ReadyTimeout() time.Duration

ReadyTimeout - возвращает максимальное время, за которое должен быть запущен планировщик со всеми его задачами.

func (*TaskScheduler) Shutdown

func (s *TaskScheduler) Shutdown(ctx context.Context) error

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

func (*TaskScheduler) Start

func (s *TaskScheduler) Start(ctx context.Context, ready func()) error

Start - запуск планировщика задач. Повторный запуск метода одно и того же объекта не предусмотрен, даже после вызова Shutdown.