schedule

Documentation

Index

• type Daily
  • func (i Daily) UntilNext(lastRanAt time.Time) time.Duration
• type Interval
  • func Every(d time.Duration) Interval
  • func (i Interval) UntilNext(lastRanAt time.Time) time.Duration
• type Monthly
  • func (i Monthly) UntilNext(lastRanAt time.Time) time.Duration
• type Repository
• type Scheduler
  • func (s Scheduler) WithSchedule(id StateID, interval tasker.Interval, job tasker.Task) tasker.Task
• type State
• type StateID
• 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 Every

func Every(d time.Duration) Interval

Every is a syntax sugar to make the reading the usage of time.Duration based Interval more fluent.

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 Repository

type Repository interface {
	Locks() guard.LockerFactory[StateID]
	States() StateRepository
}

type Scheduler

type Scheduler struct{ Repository Repository }

func (Scheduler) WithSchedule

func (s Scheduler) WithSchedule(id StateID, interval tasker.Interval, job tasker.Task) tasker.Task

Example

package main

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

func main() {
	scheduler := schedule.Scheduler{
		Repository: nil, // &postgresql.TaskerScheduleRepository{CM: cm},
	}

	task := scheduler.WithSchedule("db maintenance", schedule.Monthly{Day: 1}, func(ctx context.Context) error {
		return nil
	})

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

type State

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

type StateID

type StateID string

type StateRepository

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