scheduler

Documentation

Overview

---------------------------------------------------------------------------------------------

• Copyright (c) IBAX. All rights reserved.
• See LICENSE in the project root for license information. *--------------------------------------------------------------------------------------------

---------------------------------------------------------------------------------------------

• Copyright (c) IBAX. All rights reserved.
• See LICENSE in the project root for license information. *--------------------------------------------------------------------------------------------

Index

• func AddTask(t *Task) error
• func Parse(cronSpec string) (cron.Schedule, error)
• func UpdateTask(t *Task) error
• type Handler
• type Scheduler
  • func NewScheduler() *Scheduler
  • func (s *Scheduler) AddTask(t *Task) error
  • func (s *Scheduler) UpdateTask(t *Task) error
• type Task
  • func (t *Task) Next(tm time.Time) time.Time
  • func (t *Task) ParseCron() error
  • func (t *Task) Run()
  • func (t *Task) String() string

Functions

func AddTask

func AddTask(t *Task) error

AddTask adds task to global scheduler

func Parse

func Parse(cronSpec string) (cron.Schedule, error)

Parse parses cron format

func UpdateTask

func UpdateTask(t *Task) error

UpdateTask updates task in global scheduler

Types

type Handler

type Handler interface {
	Run(*Task)
}

Handler represents interface of task handler

type Scheduler

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

Scheduler represents wrapper over the cron library

func NewScheduler

func NewScheduler() *Scheduler

NewScheduler creates a new scheduler

func (*Scheduler) AddTask

func (s *Scheduler) AddTask(t *Task) error

AddTask adds task to cron

func (*Scheduler) UpdateTask

func (s *Scheduler) UpdateTask(t *Task) error

UpdateTask updates task

type Task

type Task struct {
	ID       string
	CronSpec string

	Handler Handler
	// contains filtered or unexported fields
}

Task represents task

func (*Task) Next

func (t *Task) Next(tm time.Time) time.Time

Next returns time for next task

func (*Task) ParseCron

func (t *Task) ParseCron() error

ParseCron parsed cron format

func (*Task) Run

func (t *Task) Run()

Run executes task

func (*Task) String

func (t *Task) String() string

String returns description of task