task

Documentation

Index

• type Task
  • func New(fn func(ctx context.Context)) *Task
  • func (t *Task) After(fn func(ctx context.Context)) *Task
  • func (t *Task) Before(fn func(ctx context.Context)) *Task
  • func (t *Task) Context(ctx context.Context) *Task
  • func (t *Task) Duration(duration time.Duration) *Task
  • func (t *Task) Run()

Types

type Task

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

Task runs a function at fixed duration.

func New

func New(fn func(ctx context.Context)) *Task

New returns a new task for use. fn is main function which will called in task loop. By default, its duration is 1min, and you can change it by Duration().

func (*Task) After

func (t *Task) After(fn func(ctx context.Context)) *Task

After sets fn to task which will be called after task stopping.

func (*Task) Before

func (t *Task) Before(fn func(ctx context.Context)) *Task

Before sets fn to task which will be called before task starting.

func (*Task) Context

func (t *Task) Context(ctx context.Context) *Task

Context sets ctx to task which will be passed to its functions in order to control context.

func (*Task) Duration

func (t *Task) Duration(duration time.Duration) *Task

Duration sets duration to task which controls the duration between two task loops.

func (*Task) Run

func (t *Task) Run()

Run runs task. You can use context to stop this task, see context.Context.