scheduler

Documentation

Index

• type ProcessFunc
• type ScheduledWorkQueue
  • func NewScheduledWorkQueue(processFunc ProcessFunc) ScheduledWorkQueue

Types

type ProcessFunc

type ProcessFunc func(interface{})

ProcessFunc is a function to process an item in the work queue.

type ScheduledWorkQueue

type ScheduledWorkQueue interface {
	// Add will add an item to this queue, executing the ProcessFunc after the
	// Duration has come (since the time Add was called). If an existing Timer
	// for obj already exists, the previous timer will be cancelled.
	Add(interface{}, time.Duration)
	// AddWithKey will add an item to this queue, executing the ProcessFunc
	// after the Duration has come (since the time Add was called). If an
	// existing Timer for key already exists, the previous timer will be
	// cancelled.
	AddWithKey(interface{}, interface{}, time.Duration)
	// Forget will cancel the timer for the given object, if the timer exists.
	Forget(interface{})
}

ScheduledWorkQueue is an interface to describe a queue that will execute the given ProcessFunc with the object given to Add once the time.Duration is up, since the time of calling Add.

func NewScheduledWorkQueue

func NewScheduledWorkQueue(processFunc ProcessFunc) ScheduledWorkQueue

NewScheduledWorkQueue will create a new workqueue with the given processFunc