schedule

Documentation

Index

• type Daily
  • func (i Daily) UntilNext(lastRanAt time.Time) time.Duration
• type Interval
  • func (i Interval) UntilNext(lastRanAt time.Time) time.Duration
• type Monthly
  • func (i Monthly) UntilNext(lastRanAt time.Time) time.Duration
• type Scheduler
  • func (s Scheduler) WithSchedule(jobid string, interval tasker.Interval, job tasker.Task) tasker.Task
• type State
• type StateRepository

Examples

• Scheduler.WithSchedule

Types

type Daily

type Daily struct {
	Hour, Minute int
	Location     *time.Location
}

func (Daily) UntilNext

func (i Daily) UntilNext(lastRanAt time.Time) time.Duration

type Interval

type Interval time.Duration

func (Interval) UntilNext

func (i Interval) UntilNext(lastRanAt time.Time) time.Duration

type Monthly

type Monthly struct {
	Day, Hour, Minute int
	Location          *time.Location
}

func (Monthly) UntilNext

func (i Monthly) UntilNext(lastRanAt time.Time) time.Duration

type Scheduler

type Scheduler struct {
	LockerFactory locks.Factory[string]
	Repository    StateRepository
}

func (Scheduler) WithSchedule

func (s Scheduler) WithSchedule(jobid string, interval tasker.Interval, job tasker.Task) tasker.Task

Example

package main

import (
	"context"
	"github.com/adamluzsi/frameless/adapters/memory"
	"github.com/adamluzsi/frameless/pkg/tasker/schedule"
	"log"
	"time"
)

func main() {
	m := schedule.Scheduler{
		LockerFactory: memory.NewLockerFactory[string](),
		Repository:    memory.NewRepository[schedule.State, string](memory.NewMemory()),
	}

	job := m.WithSchedule("db maintenance", schedule.Interval(time.Hour*24*7), func(ctx context.Context) error {
		// this job is scheduled at every seven days
		return nil
	})

	if err := job(context.Background()); err != nil {
		log.Println("ERROR", err.Error())
	}
}

type State

type State struct {
	ID        string `ext:"id"`
	Timestamp time.Time
}

type StateRepository

type StateRepository interface {
	crud.Creator[State]
	crud.Updater[State]
	crud.ByIDDeleter[string]
	crud.ByIDFinder[State, string]
}