routine

package

v1.14.0 Latest Latest Go to latest Published: Mar 25, 2024 License: Apache-2.0 Imports: 4 Imported by: 6

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

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

WithClock set a clock to a task.

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

DelayTask represents a timeout task

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

NewDelayTask creates an instance of DelayTask

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

Start executes the delayed task after given timeout.

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

Stop stops the timeout

type DelayTaskOption interface {
	SetDelayTaskOption(*DelayTask)
}

DelayTaskOption is option to DelayTask.

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

RecurringTask represents a recurring task

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

NewRecurringTask creates an instance of RecurringTask

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

Start starts the timer

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

Stop stops the timer

type RecurringTaskOption interface {
	SetRecurringTaskOption(*RecurringTask)
}

RecurringTaskOption is option to RecurringTask.

type Task func()

Task is the task logic to run.