boomerang

README

Boomerang 🪃

Simple distributed recurring task schedule for golang implemented on top of redis.

Usage

package main

import (
    "context"
    "fmt"
    "time"

    "github.com/redis/go-redis/redis/v9"
    "github.com/opsway-io/boomerang"
)

func main() {
    ctx := context.Background()

    cli := redis.NewClient(&redis.Options{
        Addr: "localhost:6379",
    })

    sch := boomerang.NewSchedule(cli)

    task := boomerang.NewTask(
        "greeter",
        "some-unique-id",
        []byte("Hello!"),
    )

    // Schedule task for execution every second starting from now
    if err := sch.Add(ctx, task, time.Second, time.Now()); err != nil {
        panic(err)
    }

    sch.On(ctx, "greeter", func(ctx context.Context, task *boomerang.Task) {
        fmt.Printf("%s\n", task.Data)
    })
}

Documentation

Index

• Variables
• type Schedule
  • func NewSchedule(redisClient *redis.Client) Schedule
• type ScheduleImpl
  • func (s *ScheduleImpl) Add(ctx context.Context, task *Task, interval time.Duration, ...) error
  • func (s *ScheduleImpl) Exists(ctx context.Context, kind string, id string) (bool, error)
  • func (s *ScheduleImpl) On(ctx context.Context, kind string, ...) error
  • func (s *ScheduleImpl) Remove(ctx context.Context, kind string, id string) error
  • func (s *ScheduleImpl) RunNow(ctx context.Context, kind string, id string) error
• type Task
  • func NewTask(kind string, id string, data []byte) *Task
• type TaskData

Variables

var (
	ErrUnexpectedReturnCode     = errors.New("unexpected return code from redis")
	ErrUnexpectedReturnCodeType = errors.New("unexpected return code type from redis, expected integer")
	ErrTaskAlreadyExists        = errors.New("task already exists")
	ErrTaskDoesNotExist         = errors.New("task does not exist")
	ErrTaskDataDoesNotExist     = errors.New("task data does not exist")
	ErrTaskDataInvalidFormat    = errors.New("task data has invalid format, expected JSON")
	ErrIntervalTooSmall         = errors.New("interval must be at least 1 millisecond")
)

Types

type Schedule

type Schedule interface {
	Add(ctx context.Context, task *Task, interval time.Duration, firstExecution time.Time) error
	Remove(ctx context.Context, kind string, id string) error
	Exists(ctx context.Context, kind string, id string) (bool, error)
	RunNow(ctx context.Context, kind string, id string) error
	On(ctx context.Context, kind string, handler func(ctx context.Context, task *Task)) error
}

func NewSchedule

func NewSchedule(redisClient *redis.Client) Schedule

type ScheduleImpl

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

func (*ScheduleImpl) Add

func (s *ScheduleImpl) Add(ctx context.Context, task *Task, interval time.Duration, firstExecution time.Time) error

func (*ScheduleImpl) Exists

func (s *ScheduleImpl) Exists(ctx context.Context, kind string, id string) (bool, error)

func (*ScheduleImpl) On

func (s *ScheduleImpl) On(ctx context.Context, kind string, handler func(ctx context.Context, task *Task)) error

func (*ScheduleImpl) Remove

func (s *ScheduleImpl) Remove(ctx context.Context, kind string, id string) error

func (*ScheduleImpl) RunNow

func (s *ScheduleImpl) RunNow(ctx context.Context, kind string, id string) error

type Task

type Task struct {
	Kind string
	ID   string
	Data []byte
}

func NewTask

func NewTask(kind string, id string, data []byte) *Task

type TaskData

type TaskData struct {
	Interval time.Duration
	Data     []byte
}