workers

Apr 26, 2026

Changes in this version

+ var ErrSkipTick = errors.New("workers: skip tick")

type Worker

+ func (w *Worker) GetInitialDelay() time.Duration

+ func (w *Worker) GetInterval() time.Duration

+ func (w *Worker) GetJitterPercent() int

+ func (w *Worker) GetRestartOnFail() bool

type WorkerInfo

+ func (info *WorkerInfo) GetChildCount() int

+ func (info *WorkerInfo) GetHandler() CycleHandler

type WorkerInfoOption

+ func WithTestHandler(h CycleHandler) WorkerInfoOption

Apr 24, 2026

Changes in this version

+ var ErrDoNotRestart = suture.ErrDoNotRestart

+ type CycleFunc func(ctx context.Context, info *WorkerInfo) error

+ func (fn CycleFunc) Close() error

+ func (fn CycleFunc) RunCycle(ctx context.Context, info *WorkerInfo) error

+ type CycleHandler interface

+ Close func() error

+ RunCycle func(ctx context.Context, info *WorkerInfo) error

+ type Middleware func(ctx context.Context, info *WorkerInfo, next CycleFunc) error

type RunOption

+ func AddInterceptors(mw ...Middleware) RunOption

+ func WithDefaultJitter(percent int) RunOption

+ func WithInterceptors(mw ...Middleware) RunOption

type Worker

+ func (w *Worker) AddInterceptors(mw ...Middleware) *Worker

+ func (w *Worker) GetHandler() CycleHandler

+ func (w *Worker) GetName() string

+ func (w *Worker) Handler(h CycleHandler) *Worker

+ func (w *Worker) HandlerFunc(fn CycleFunc) *Worker

+ func (w *Worker) Interceptors(mw ...Middleware) *Worker

+ func (w *Worker) WithInitialDelay(d time.Duration) *Worker

+ func (w *Worker) WithJitter(percent int) *Worker

+ type WorkerInfo struct

+ func NewWorkerInfo(name string, attempt int, opts ...WorkerInfoOption) *WorkerInfo

+ func (info *WorkerInfo) Add(w *Worker) bool

+ func (info *WorkerInfo) GetAttempt() int

+ func (info *WorkerInfo) GetChild(name string) (Worker, bool)

+ func (info *WorkerInfo) GetChildren() []string

+ func (info *WorkerInfo) GetName() string

+ func (info *WorkerInfo) Remove(name string)

+ type WorkerInfoOption func(*WorkerInfo)

+ func WithTestChildren(ctx context.Context) WorkerInfoOption

Apr 5, 2026

Changes in this version

+ type BaseMetrics struct

+ func (BaseMetrics) ObserveRunDuration(string, time.Duration)

+ func (BaseMetrics) SetActiveWorkers(int)

+ func (BaseMetrics) WorkerFailed(string, error)

+ func (BaseMetrics) WorkerPanicked(string)

+ func (BaseMetrics) WorkerRestarted(string, int)

+ func (BaseMetrics) WorkerStarted(string)

+ func (BaseMetrics) WorkerStopped(string)

Apr 5, 2026

Changes in this version

+ type Metrics interface

+ ObserveRunDuration func(name string, duration time.Duration)

+ SetActiveWorkers func(count int)

+ WorkerFailed func(name string, err error)

+ WorkerPanicked func(name string)

+ WorkerRestarted func(name string, attempt int)

+ WorkerStarted func(name string)

+ WorkerStopped func(name string)

+ var NoopMetrics Metrics = &noopMetrics{}

+ func NewPrometheusMetrics(namespace string) Metrics

+ type RunOption func(*runConfig)

+ func WithMetrics(m Metrics) RunOption

type Worker

+ func (w *Worker) WithMetrics(m Metrics) *Worker

Apr 5, 2026

Changes in this version

+ func BatchChannelWorker[T any](ch <-chan T, maxSize int, maxDelay time.Duration, ...) func(WorkerContext) error

+ func ChannelWorker[T any](ch <-chan T, fn func(WorkerContext, T) error) func(WorkerContext) error

+ func EveryInterval(d time.Duration, fn func(WorkerContext) error) func(WorkerContext) error

+ func Run(ctx context.Context, workers []*Worker) error

+ func RunWorker(ctx context.Context, w *Worker)

+ type Worker struct

+ func NewWorker(name string, run func(WorkerContext) error) *Worker

+ func (w *Worker) Every(d time.Duration) *Worker

+ func (w *Worker) WithBackoffJitter(jitter suture.Jitter) *Worker

+ func (w *Worker) WithFailureBackoff(d time.Duration) *Worker

+ func (w *Worker) WithFailureDecay(decay float64) *Worker

+ func (w *Worker) WithFailureThreshold(threshold float64) *Worker

+ func (w *Worker) WithRestart(restart bool) *Worker

+ func (w *Worker) WithTimeout(d time.Duration) *Worker

+ type WorkerContext interface

+ Add func(w *Worker)

+ Attempt func() int

+ Children func() []string

+ Name func() string

+ Remove func(name string)