routine

Documentation

Index

• func WithClock(c clock.Clock) interface{ ... }
• type DelayTask
  • func NewDelayTask(cb Task, d time.Duration, ops ...DelayTaskOption) *DelayTask
  • func (t *DelayTask) Start(ctx context.Context) error
  • func (t *DelayTask) Stop(ctx context.Context) error
• type DelayTaskOption
• type RecurringTask
  • func NewRecurringTask(t Task, i time.Duration, ops ...RecurringTaskOption) *RecurringTask
  • func (t *RecurringTask) Start(_ context.Context) error
  • func (t *RecurringTask) Stop(_ context.Context) error
• type RecurringTaskOption
• type Task

Functions

func WithClock

func WithClock(c clock.Clock) interface {
	RecurringTaskOption
	DelayTaskOption
}

WithClock set a clock to a task.

Types

type DelayTask

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

DelayTask represents a timeout task

func NewDelayTask

func NewDelayTask(cb Task, d time.Duration, ops ...DelayTaskOption) *DelayTask

NewDelayTask creates an instance of DelayTask

func (*DelayTask) Start

func (t *DelayTask) Start(ctx context.Context) error

Start executes the delayed task after given timeout.

func (*DelayTask) Stop

func (t *DelayTask) Stop(ctx context.Context) error

Stop stops the timeout

type DelayTaskOption

type DelayTaskOption interface {
	SetDelayTaskOption(*DelayTask)
}

DelayTaskOption is option to DelayTask.

type RecurringTask

type RecurringTask struct {
	lifecycle.Readiness
	// contains filtered or unexported fields
}

RecurringTask represents a recurring task

func NewRecurringTask

func NewRecurringTask(t Task, i time.Duration, ops ...RecurringTaskOption) *RecurringTask

NewRecurringTask creates an instance of RecurringTask

func (*RecurringTask) Start

func (t *RecurringTask) Start(_ context.Context) error

Start starts the timer

func (*RecurringTask) Stop

func (t *RecurringTask) Stop(_ context.Context) error

Stop stops the timer

type RecurringTaskOption

type RecurringTaskOption interface {
	SetRecurringTaskOption(*RecurringTask)
}

RecurringTaskOption is option to RecurringTask.

type Task

type Task func()

Task is the task logic to run.