backgroundjob

Documentation

Index

• Constants
• func Main(ctx context.Context, logger *log.Logger, runners []*Runner)
• type Runnable
• type RunnableFactory
• type Runner
  • func NewRunner(ctx context.Context, logger *log.Logger, runnableFactory RunnableFactory, ...) *Runner
  • func (r *Runner) Start()
  • func (r *Runner) Stop(ctx context.Context)
• type RunnerOption
  • func WithAfterDuration(d time.Duration) RunnerOption

Constants

const DefaultAfterDuration = 5 * time.Minute

Functions

func Main

func Main(ctx context.Context, logger *log.Logger, runners []*Runner)

Main takes a list of runners and start them. Upon receiving SIGINT or SIGTERM, stop them gracefully.

Types

type Runnable

type Runnable interface {
	Run(ctx context.Context) error
}

type RunnableFactory

type RunnableFactory func() Runnable

type Runner

type Runner struct {
	// contains filtered or unexported fields
}

func NewRunner

func NewRunner(ctx context.Context, logger *log.Logger, runnableFactory RunnableFactory, opts ...RunnerOption) *Runner

func (*Runner) Start

func (r *Runner) Start()

func (*Runner) Stop

func (r *Runner) Stop(ctx context.Context)

type RunnerOption

type RunnerOption interface {
	// contains filtered or unexported methods
}

func WithAfterDuration

func WithAfterDuration(d time.Duration) RunnerOption