util

Documentation

Index

• func Schedule(action func() error, interval time.Duration, errorMessage string)
• func ScheduleNow(action func() error, interval time.Duration, errorMessage string)
• func WaitUntil(fn func() error, timeout time.Duration) error
• type Reminder
  • func NewReminder(logger *logrus.Logger, interval time.Duration) *Reminder
  • func (reminder *Reminder) Remind(message string, fields ...logrus.Fields)
  • func (reminder *Reminder) RemindWith(message string, key string, value interface{})

Functions

func Schedule

func Schedule(action func() error, interval time.Duration, errorMessage string)

Schedule runs the specified `action` periodically.

func ScheduleNow

func ScheduleNow(action func() error, interval time.Duration, errorMessage string)

ScheduleNow runs the specified `action` immediately and periodically.

func WaitUntil

func WaitUntil(fn func() error, timeout time.Duration) error

WaitUntil runs the given function within a time duration

Types

type Reminder

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

Reminder is used for time consuming operations to remind user about progress.

func NewReminder

func NewReminder(logger *logrus.Logger, interval time.Duration) *Reminder

NewReminder returns a new Reminder instance.

`level`: log level to remind in general.

`interval`: interval to remind in warning level.

func (*Reminder) Remind

func (reminder *Reminder) Remind(message string, fields ...logrus.Fields)

Remind reminds about specified `message` and optional `fields`.

func (*Reminder) RemindWith

func (reminder *Reminder) RemindWith(message string, key string, value interface{})

RemindWith reminds about specified `message` along with `key` and `value`.