beat

Sep 20, 2026

Changes in this version

type Option

+ func WithAssignment(r *assignment.Rotation) Option

+ func WithDecisionHandler(fn func(assignment.Decision)) Option

type Record

+ GridPoint time.Time

+ LocalPeriod time.Duration

+ Result job.Result

Sep 18, 2026

Changes in this version

+ var ErrAlreadyStarted = errors.New("beat is already started")

+ var ErrStillRunning = errors.New("stop deadline elapsed before the run finished")

+ var ErrStopped = errors.New("beat is stopped")

+ func OffsetFor(id string, max time.Duration) time.Duration

type Beat

+ func (b *Beat) Done() <-chan struct{}

type Config

+ Period time.Duration

type Mode

+ const ModeFixedDelay

+ const ModeFixedRate

type Option

+ func WithBackoff(fn func(Record) time.Duration) Option

+ func WithMode(m Mode) Option

+ func WithOffset(d time.Duration) Option

+ type Outcome string

+ const OutcomeCanceled

+ const OutcomeError

+ const OutcomeOK

+ const OutcomePanic

+ const OutcomeTimeout

type Record

+ Missed int

+ Outcome Outcome

+ Period time.Duration

+ ScheduledFor time.Time

Sep 17, 2026

Changes in this version

type Config

+ func (Config) ConfigName() string

Aug 25, 2026

Changes in this version

type Config

+ func (c *Config) SetDefaults()

Aug 6, 2026

Changes in this version

+ func Wait(ctx context.Context, d time.Duration)

+ type Beat struct

+ func MakeBeat(cfg Config, job Job, handler Handler, opts ...Option) (*Beat, error)

+ func (b *Beat) Start(ctx context.Context) error

+ func (b *Beat) Stop(ctx context.Context) error

+ type Config struct

+ Jitter time.Duration

+ JobTimeout time.Duration

+ Spec string

+ func (c Config) Validate() error

+ type Handler interface

+ Handle func(ctx context.Context, r Record)

+ func MultiHandler(handlers ...Handler) Handler

+ type HandlerFunc func(ctx context.Context, r Record)

+ func (f HandlerFunc) Handle(ctx context.Context, r Record)

+ type Job func(ctx context.Context) (int, error)

+ type Middleware func(next Job) Job

+ type Mode string

+ const ModeCron

+ const ModeInterval

+ type Option interface

+ func WithGracefulStop() Option

+ func WithHandler(h Handler) Option

+ func WithMiddleware(mw ...Middleware) Option

+ func WithOnStart(h func(context.Context) error) Option

+ func WithOnStop(h func(context.Context) error) Option

+ type PanicError struct

+ Stack []byte

+ Value any

+ func (e *PanicError) Error() string

+ type Record struct

+ Duration time.Duration

+ Err error

+ Iteration int64

+ Mode Mode

+ Processed int

+ Start time.Time