periodictask

Documentation

Index

• Variables
• type Config
  • func CreateDefaultConfig() Config
• type Coordinator
• type PeriodicSingleTaskRunner
  • func NewSingleTaskRunner(ctx context.Context, taskKey string, taskFunc func(context.Context) error, ...) *PeriodicSingleTaskRunner
  • func (r *PeriodicSingleTaskRunner) Done() <-chan struct{}

Variables

var StackTraceLogField = "stack-trace"

Types

type Config

type Config struct {
	TaskInterval    time.Duration
	TaskTimeout     time.Duration
	RunnerFrequency time.Duration
}

func CreateDefaultConfig

func CreateDefaultConfig() Config

type Coordinator

type Coordinator interface {
	locker.Locker

	LastRunTimestamp(
		ctx context.Context,
		key string,
	) (*time.Time, error)

	UpdateLastRunTimestamp(
		ctx context.Context,
		key string,
	) error
}

type PeriodicSingleTaskRunner

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

func NewSingleTaskRunner

func NewSingleTaskRunner(
	ctx context.Context,
	taskKey string,
	taskFunc func(context.Context) error,
	coordinator Coordinator,
	config *Config,
) *PeriodicSingleTaskRunner

func (*PeriodicSingleTaskRunner) Done

func (r *PeriodicSingleTaskRunner) Done() <-chan struct{}

Done copied from context.Context