tasks

package

v0.9.3 Latest Latest Go to latest Published: Apr 22, 2018 License: GPL-3.0 Imports: 5 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

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

Scheduler implements a basic dispatcher for tasks. Each task is simply a go routine that will do something in the background

func NewScheduler(interval uint) (*Scheduler, error)

NewScheduler initialize a new scheduler.

func (s *Scheduler) RegisterTask(task SchedulerTask) error

RegisterTask adds the task to the task queue of the scheduler. All tasks in this queue will be started later.

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

StartTasks starts each previously registered task. The starting will be done parallel.

type SchedulerTask interface {
	Name() string
	Run(ctx context.Context) error
}

A SchedulerTask handles different tasks (jobs) in the background.

type TaskInstrumenting struct {
	Next SchedulerTask
}

TaskInstrumenting implements a Prometheus instrumenting around regular SchedulerTask(s).

func (ti *TaskInstrumenting) Name() string

Name returns the name of the underlaying task.

func (ti *TaskInstrumenting) Run(ctx context.Context) error

Run exports metrics of the current task and executes the underlaying task.

type TaskLogger struct {
	Next SchedulerTask
}

TaskLogger implements logging functions around regular SchedulerTask(s).

func (tl *TaskLogger) Name() string

Name returns the name of the underlaying task.

func (tl *TaskLogger) Run(ctx context.Context) error

Run logs the current task and executes the underlaying task.