services

Documentation

Index

• func ExponentialBackoff(d time.Duration) time.Duration
• func Start(name string, config *Config)
• type Args
• type Config
• type Service

Functions

func ExponentialBackoff

func ExponentialBackoff(d time.Duration) time.Duration

ExponentialBackoff transforms a time.Duration to the next time.Duration using exponential backoff.

func Start

func Start(name string, config *Config)

Types

type Args

type Args struct {
	Logger *slog.Logger
}

type Config

type Config struct {
	// Service is an instance of the service.
	Service Service

	// StartDelay is the delay before starting the service.
	StartDelay time.Duration

	// RunInterval is the interval between runs.
	RunInterval time.Duration

	// RunIntervalFunc is a function that returns the interval between runs. It takes precedence
	// over RunInterval.
	RunIntervalFunc func() time.Duration

	// Enabled is a function that returns whether or not the service is currently enabled.
	Enabled func() bool

	// InitialRestartInterval is the initial restart interval.
	InitialRestartInterval time.Duration

	// NextRestartInterval is a function that receives the last restart interval and returns the
	// next one.
	NextRestartInterval func(time.Duration) time.Duration

	// Quiet indicates whether service start and finish should be logged.
	Quiet bool
}

type Service

type Service interface {
	// Init initialises the service and returns an error if init failed. If an error is returned
	// then the service will not run.
	Init(args *Args) error

	// Run runs the service and returns an error for an unrecoverable failure.
	Run() error
}