task

Documentation

Index

• type JobWrapper
  • func NewJobWrapper(job mrworker.Job, opts ...Option) *JobWrapper
  • func (j *JobWrapper) Caption() string
  • func (j *JobWrapper) Do(ctx context.Context) error
  • func (j *JobWrapper) Period() time.Duration
  • func (j *JobWrapper) Startup() bool
  • func (j *JobWrapper) Timeout() time.Duration
• type Option
  • func WithCaption(value string) Option
  • func WithPeriod(value time.Duration) Option
  • func WithStartup(value bool) Option
  • func WithTimeout(value time.Duration) Option

Types

type JobWrapper

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

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

func NewJobWrapper

func NewJobWrapper(job mrworker.Job, opts ...Option) *JobWrapper

NewJobWrapper - создаёт объект JobWrapper.

func (*JobWrapper) Caption

func (j *JobWrapper) Caption() string

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

func (*JobWrapper) Do

func (j *JobWrapper) Do(ctx context.Context) error

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

func (*JobWrapper) Period

func (j *JobWrapper) Period() time.Duration

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

func (*JobWrapper) Startup

func (j *JobWrapper) Startup() bool

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

func (*JobWrapper) Timeout

func (j *JobWrapper) Timeout() time.Duration

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

type Option

type Option func(j *JobWrapper)

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

func WithCaption

func WithCaption(value string) Option

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

func WithPeriod

func WithPeriod(value time.Duration) Option

WithPeriod - устанавливает опцию period для JobWrapper.

func WithStartup

func WithStartup(value bool) Option

WithStartup - устанавливает опцию startup для JobWrapper.

func WithTimeout

func WithTimeout(value time.Duration) Option

WithTimeout - устанавливает опцию timeout для JobWrapper.